Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-sql

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AuthenticationType

AuthenticationType: "SQL" | "ADPassword"

Defines values for AuthenticationType. Possible values include: 'SQL', 'ADPassword'

readonly
enum

{string}

AutomaticTuningDisabledReason

AutomaticTuningDisabledReason: "Default" | "Disabled" | "AutoConfigured" | "InheritedFromServer" | "QueryStoreOff" | "QueryStoreReadOnly" | "NotSupported"

Defines values for AutomaticTuningDisabledReason. Possible values include: 'Default', 'Disabled', 'AutoConfigured', 'InheritedFromServer', 'QueryStoreOff', 'QueryStoreReadOnly', 'NotSupported'

readonly
enum

{string}

AutomaticTuningMode

AutomaticTuningMode: "Inherit" | "Custom" | "Auto" | "Unspecified"

Defines values for AutomaticTuningMode. Possible values include: 'Inherit', 'Custom', 'Auto', 'Unspecified'

readonly
enum

{string}

AutomaticTuningOptionModeActual

AutomaticTuningOptionModeActual: "Off" | "On"

Defines values for AutomaticTuningOptionModeActual. Possible values include: 'Off', 'On'

readonly
enum

{string}

AutomaticTuningOptionModeDesired

AutomaticTuningOptionModeDesired: "Off" | "On" | "Default"

Defines values for AutomaticTuningOptionModeDesired. Possible values include: 'Off', 'On', 'Default'

readonly
enum

{string}

AutomaticTuningServerMode

AutomaticTuningServerMode: "Custom" | "Auto" | "Unspecified"

Defines values for AutomaticTuningServerMode. Possible values include: 'Custom', 'Auto', 'Unspecified'

readonly
enum

{string}

AutomaticTuningServerReason

AutomaticTuningServerReason: "Default" | "Disabled" | "AutoConfigured"

Defines values for AutomaticTuningServerReason. Possible values include: 'Default', 'Disabled', 'AutoConfigured'

readonly
enum

{string}

BackupLongTermRetentionPoliciesBeginCreateOrUpdateResponse

BackupLongTermRetentionPoliciesBeginCreateOrUpdateResponse: BackupLongTermRetentionPolicy & object

Contains response data for the beginCreateOrUpdate operation.

BackupLongTermRetentionPoliciesCreateOrUpdateResponse

BackupLongTermRetentionPoliciesCreateOrUpdateResponse: BackupLongTermRetentionPolicy & object

Contains response data for the createOrUpdate operation.

BackupLongTermRetentionPoliciesGetResponse

BackupLongTermRetentionPoliciesGetResponse: BackupLongTermRetentionPolicy & object

Contains response data for the get operation.

BackupLongTermRetentionPoliciesListByDatabaseResponse

BackupLongTermRetentionPoliciesListByDatabaseResponse: BackupLongTermRetentionPolicy & object

Contains response data for the listByDatabase operation.

BackupShortTermRetentionPoliciesBeginCreateOrUpdateResponse

BackupShortTermRetentionPoliciesBeginCreateOrUpdateResponse: BackupShortTermRetentionPolicy & object

Contains response data for the beginCreateOrUpdate operation.

BackupShortTermRetentionPoliciesBeginUpdateResponse

BackupShortTermRetentionPoliciesBeginUpdateResponse: BackupShortTermRetentionPolicy & object

Contains response data for the beginUpdate operation.

BackupShortTermRetentionPoliciesCreateOrUpdateResponse

BackupShortTermRetentionPoliciesCreateOrUpdateResponse: BackupShortTermRetentionPolicy & object

Contains response data for the createOrUpdate operation.

BackupShortTermRetentionPoliciesGetResponse

BackupShortTermRetentionPoliciesGetResponse: BackupShortTermRetentionPolicy & object

Contains response data for the get operation.

BackupShortTermRetentionPoliciesListByDatabaseNextResponse

BackupShortTermRetentionPoliciesListByDatabaseNextResponse: BackupShortTermRetentionPolicyListResult & object

Contains response data for the listByDatabaseNext operation.

BackupShortTermRetentionPoliciesListByDatabaseResponse

BackupShortTermRetentionPoliciesListByDatabaseResponse: BackupShortTermRetentionPolicyListResult & object

Contains response data for the listByDatabase operation.

BackupShortTermRetentionPoliciesUpdateResponse

BackupShortTermRetentionPoliciesUpdateResponse: BackupShortTermRetentionPolicy & object

Contains response data for the update operation.

BlobAuditingPolicyState

BlobAuditingPolicyState: "Enabled" | "Disabled"

Defines values for BlobAuditingPolicyState. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

CapabilitiesListByLocationResponse

CapabilitiesListByLocationResponse: LocationCapabilities & object

Contains response data for the listByLocation operation.

CapabilityGroup

CapabilityGroup: "supportedEditions" | "supportedElasticPoolEditions" | "supportedManagedInstanceVersions"

Defines values for CapabilityGroup. Possible values include: 'supportedEditions', 'supportedElasticPoolEditions', 'supportedManagedInstanceVersions'

readonly
enum

{string}

CapabilityStatus

CapabilityStatus: "Visible" | "Available" | "Default" | "Disabled"

Defines values for CapabilityStatus. Possible values include: 'Visible', 'Available', 'Default', 'Disabled'

readonly
enum

{string}

CatalogCollationType

CatalogCollationType: "DATABASE_DEFAULT" | "SQL_Latin1_General_CP1_CI_AS"

Defines values for CatalogCollationType. Possible values include: 'DATABASE_DEFAULT', 'SQL_Latin1_General_CP1_CI_AS'

readonly
enum

{string}

CheckNameAvailabilityReason

CheckNameAvailabilityReason: "Invalid" | "AlreadyExists"

Defines values for CheckNameAvailabilityReason. Possible values include: 'Invalid', 'AlreadyExists'

readonly
enum

{string}

CreateMode

CreateMode: "Default" | "Copy" | "Secondary" | "PointInTimeRestore" | "Restore" | "Recovery" | "RestoreExternalBackup" | "RestoreExternalBackupSecondary" | "RestoreLongTermRetentionBackup" | "OnlineSecondary"

Defines values for CreateMode. Possible values include: 'Default', 'Copy', 'Secondary', 'PointInTimeRestore', 'Restore', 'Recovery', 'RestoreExternalBackup', 'RestoreExternalBackupSecondary', 'RestoreLongTermRetentionBackup', 'OnlineSecondary'

readonly
enum

{string}

DataMaskingFunction

DataMaskingFunction: "Default" | "CCN" | "Email" | "Number" | "SSN" | "Text"

Defines values for DataMaskingFunction. Possible values include: 'Default', 'CCN', 'Email', 'Number', 'SSN', 'Text'

readonly
enum

{string}

DataMaskingPoliciesCreateOrUpdateResponse

DataMaskingPoliciesCreateOrUpdateResponse: DataMaskingPolicy & object

Contains response data for the createOrUpdate operation.

DataMaskingPoliciesGetResponse

DataMaskingPoliciesGetResponse: DataMaskingPolicy & object

Contains response data for the get operation.

DataMaskingRuleState

DataMaskingRuleState: "Disabled" | "Enabled"

Defines values for DataMaskingRuleState. Possible values include: 'Disabled', 'Enabled'

readonly
enum

{string}

DataMaskingRulesCreateOrUpdateResponse

DataMaskingRulesCreateOrUpdateResponse: DataMaskingRule & object

Contains response data for the createOrUpdate operation.

DataMaskingRulesListByDatabaseResponse

DataMaskingRulesListByDatabaseResponse: DataMaskingRuleListResult & object

Contains response data for the listByDatabase operation.

DataMaskingState

DataMaskingState: "Disabled" | "Enabled"

Defines values for DataMaskingState. Possible values include: 'Disabled', 'Enabled'

readonly
enum

{string}

DatabaseAutomaticTuningGetResponse

DatabaseAutomaticTuningGetResponse: DatabaseAutomaticTuning & object

Contains response data for the get operation.

DatabaseAutomaticTuningUpdateResponse

DatabaseAutomaticTuningUpdateResponse: DatabaseAutomaticTuning & object

Contains response data for the update operation.

DatabaseBlobAuditingPoliciesCreateOrUpdateResponse

DatabaseBlobAuditingPoliciesCreateOrUpdateResponse: DatabaseBlobAuditingPolicy & object

Contains response data for the createOrUpdate operation.

DatabaseBlobAuditingPoliciesGetResponse

DatabaseBlobAuditingPoliciesGetResponse: DatabaseBlobAuditingPolicy & object

Contains response data for the get operation.

DatabaseEdition

DatabaseEdition: "Web" | "Business" | "Basic" | "Standard" | "Premium" | "PremiumRS" | "Free" | "Stretch" | "DataWarehouse" | "System" | "System2"

Defines values for DatabaseEdition. Possible values include: 'Web', 'Business', 'Basic', 'Standard', 'Premium', 'PremiumRS', 'Free', 'Stretch', 'DataWarehouse', 'System', 'System2'

readonly
enum

{string}

DatabaseLicenseType

DatabaseLicenseType: "LicenseIncluded" | "BasePrice"

Defines values for DatabaseLicenseType. Possible values include: 'LicenseIncluded', 'BasePrice'

readonly
enum

{string}

DatabaseOperationsListByDatabaseNextResponse

DatabaseOperationsListByDatabaseNextResponse: DatabaseOperationListResult & object

Contains response data for the listByDatabaseNext operation.

DatabaseOperationsListByDatabaseResponse

DatabaseOperationsListByDatabaseResponse: DatabaseOperationListResult & object

Contains response data for the listByDatabase operation.

DatabaseReadScale

DatabaseReadScale: "Enabled" | "Disabled"

Defines values for DatabaseReadScale. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

DatabaseStatus

DatabaseStatus: "Online" | "Restoring" | "RecoveryPending" | "Recovering" | "Suspect" | "Offline" | "Standby" | "Shutdown" | "EmergencyMode" | "AutoClosed" | "Copying" | "Creating" | "Inaccessible" | "OfflineSecondary" | "Pausing" | "Paused" | "Resuming" | "Scaling"

Defines values for DatabaseStatus. Possible values include: 'Online', 'Restoring', 'RecoveryPending', 'Recovering', 'Suspect', 'Offline', 'Standby', 'Shutdown', 'EmergencyMode', 'AutoClosed', 'Copying', 'Creating', 'Inaccessible', 'OfflineSecondary', 'Pausing', 'Paused', 'Resuming', 'Scaling'

readonly
enum

{string}

DatabaseThreatDetectionPoliciesCreateOrUpdateResponse

DatabaseThreatDetectionPoliciesCreateOrUpdateResponse: DatabaseSecurityAlertPolicy & object

Contains response data for the createOrUpdate operation.

DatabaseThreatDetectionPoliciesGetResponse

DatabaseThreatDetectionPoliciesGetResponse: DatabaseSecurityAlertPolicy & object

Contains response data for the get operation.

DatabaseUsagesListByDatabaseResponse

DatabaseUsagesListByDatabaseResponse: DatabaseUsageListResult & object

Contains response data for the listByDatabase operation.

DatabaseVulnerabilityAssessmentRuleBaselinesCreateOrUpdateResponse

DatabaseVulnerabilityAssessmentRuleBaselinesCreateOrUpdateResponse: DatabaseVulnerabilityAssessmentRuleBaseline & object

Contains response data for the createOrUpdate operation.

DatabaseVulnerabilityAssessmentRuleBaselinesGetResponse

DatabaseVulnerabilityAssessmentRuleBaselinesGetResponse: DatabaseVulnerabilityAssessmentRuleBaseline & object

Contains response data for the get operation.

DatabaseVulnerabilityAssessmentScansExportMethodResponse

DatabaseVulnerabilityAssessmentScansExportMethodResponse: DatabaseVulnerabilityAssessmentScansExport & object

Contains response data for the exportMethod operation.

DatabaseVulnerabilityAssessmentScansGetResponse

DatabaseVulnerabilityAssessmentScansGetResponse: VulnerabilityAssessmentScanRecord & object

Contains response data for the get operation.

DatabaseVulnerabilityAssessmentScansListByDatabaseNextResponse

DatabaseVulnerabilityAssessmentScansListByDatabaseNextResponse: VulnerabilityAssessmentScanRecordListResult & object

Contains response data for the listByDatabaseNext operation.

DatabaseVulnerabilityAssessmentScansListByDatabaseResponse

DatabaseVulnerabilityAssessmentScansListByDatabaseResponse: VulnerabilityAssessmentScanRecordListResult & object

Contains response data for the listByDatabase operation.

DatabaseVulnerabilityAssessmentsCreateOrUpdateResponse

DatabaseVulnerabilityAssessmentsCreateOrUpdateResponse: DatabaseVulnerabilityAssessment & object

Contains response data for the createOrUpdate operation.

DatabaseVulnerabilityAssessmentsGetResponse

DatabaseVulnerabilityAssessmentsGetResponse: DatabaseVulnerabilityAssessment & object

Contains response data for the get operation.

DatabaseVulnerabilityAssessmentsListByDatabaseNextResponse

DatabaseVulnerabilityAssessmentsListByDatabaseNextResponse: DatabaseVulnerabilityAssessmentListResult & object

Contains response data for the listByDatabaseNext operation.

DatabaseVulnerabilityAssessmentsListByDatabaseResponse

DatabaseVulnerabilityAssessmentsListByDatabaseResponse: DatabaseVulnerabilityAssessmentListResult & object

Contains response data for the listByDatabase operation.

DatabasesBeginCreateImportOperationResponse

DatabasesBeginCreateImportOperationResponse: ImportExportResponse & object

Contains response data for the beginCreateImportOperation operation.

DatabasesBeginCreateOrUpdateResponse

DatabasesBeginCreateOrUpdateResponse: Database & object

Contains response data for the beginCreateOrUpdate operation.

DatabasesBeginExportMethodResponse

DatabasesBeginExportMethodResponse: ImportExportResponse & object

Contains response data for the beginExportMethod operation.

DatabasesBeginImportMethodResponse

DatabasesBeginImportMethodResponse: ImportExportResponse & object

Contains response data for the beginImportMethod operation.

DatabasesBeginPauseResponse

DatabasesBeginPauseResponse: Database & object

Contains response data for the beginPause operation.

DatabasesBeginResumeResponse

DatabasesBeginResumeResponse: Database & object

Contains response data for the beginResume operation.

DatabasesBeginUpdateResponse

DatabasesBeginUpdateResponse: Database & object

Contains response data for the beginUpdate operation.

DatabasesCreateImportOperationResponse

DatabasesCreateImportOperationResponse: ImportExportResponse & object

Contains response data for the createImportOperation operation.

DatabasesCreateOrUpdateResponse

DatabasesCreateOrUpdateResponse: Database & object

Contains response data for the createOrUpdate operation.

DatabasesExportMethodResponse

DatabasesExportMethodResponse: ImportExportResponse & object

Contains response data for the exportMethod operation.

DatabasesGetResponse

DatabasesGetResponse: Database & object

Contains response data for the get operation.

DatabasesImportMethodResponse

DatabasesImportMethodResponse: ImportExportResponse & object

Contains response data for the importMethod operation.

DatabasesListByElasticPoolNextResponse

DatabasesListByElasticPoolNextResponse: DatabaseListResult & object

Contains response data for the listByElasticPoolNext operation.

DatabasesListByElasticPoolResponse

DatabasesListByElasticPoolResponse: DatabaseListResult & object

Contains response data for the listByElasticPool operation.

DatabasesListByServerNextResponse

DatabasesListByServerNextResponse: DatabaseListResult & object

Contains response data for the listByServerNext operation.

DatabasesListByServerResponse

DatabasesListByServerResponse: DatabaseListResult & object

Contains response data for the listByServer operation.

DatabasesListMetricDefinitionsResponse

DatabasesListMetricDefinitionsResponse: MetricDefinitionListResult & object

Contains response data for the listMetricDefinitions operation.

DatabasesListMetricsResponse

DatabasesListMetricsResponse: MetricListResult & object

Contains response data for the listMetrics operation.

DatabasesPauseResponse

DatabasesPauseResponse: Database & object

Contains response data for the pause operation.

DatabasesResumeResponse

DatabasesResumeResponse: Database & object

Contains response data for the resume operation.

DatabasesUpdateResponse

DatabasesUpdateResponse: Database & object

Contains response data for the update operation.

ElasticPoolActivitiesListByElasticPoolResponse

ElasticPoolActivitiesListByElasticPoolResponse: ElasticPoolActivityListResult & object

Contains response data for the listByElasticPool operation.

ElasticPoolDatabaseActivitiesListByElasticPoolResponse

ElasticPoolDatabaseActivitiesListByElasticPoolResponse: ElasticPoolDatabaseActivityListResult & object

Contains response data for the listByElasticPool operation.

ElasticPoolEdition

ElasticPoolEdition: "Basic" | "Standard" | "Premium"

Defines values for ElasticPoolEdition. Possible values include: 'Basic', 'Standard', 'Premium'

readonly
enum

{string}

ElasticPoolLicenseType

ElasticPoolLicenseType: "LicenseIncluded" | "BasePrice"

Defines values for ElasticPoolLicenseType. Possible values include: 'LicenseIncluded', 'BasePrice'

readonly
enum

{string}

ElasticPoolOperationsListByElasticPoolNextResponse

ElasticPoolOperationsListByElasticPoolNextResponse: ElasticPoolOperationListResult & object

Contains response data for the listByElasticPoolNext operation.

ElasticPoolOperationsListByElasticPoolResponse

ElasticPoolOperationsListByElasticPoolResponse: ElasticPoolOperationListResult & object

Contains response data for the listByElasticPool operation.

ElasticPoolState

ElasticPoolState: "Creating" | "Ready" | "Disabled"

Defines values for ElasticPoolState. Possible values include: 'Creating', 'Ready', 'Disabled'

readonly
enum

{string}

ElasticPoolsBeginCreateOrUpdateResponse

ElasticPoolsBeginCreateOrUpdateResponse: ElasticPool & object

Contains response data for the beginCreateOrUpdate operation.

ElasticPoolsBeginUpdateResponse

ElasticPoolsBeginUpdateResponse: ElasticPool & object

Contains response data for the beginUpdate operation.

ElasticPoolsCreateOrUpdateResponse

ElasticPoolsCreateOrUpdateResponse: ElasticPool & object

Contains response data for the createOrUpdate operation.

ElasticPoolsGetResponse

ElasticPoolsGetResponse: ElasticPool & object

Contains response data for the get operation.

ElasticPoolsListByServerNextResponse

ElasticPoolsListByServerNextResponse: ElasticPoolListResult & object

Contains response data for the listByServerNext operation.

ElasticPoolsListByServerResponse

ElasticPoolsListByServerResponse: ElasticPoolListResult & object

Contains response data for the listByServer operation.

ElasticPoolsListMetricDefinitionsResponse

ElasticPoolsListMetricDefinitionsResponse: MetricDefinitionListResult & object

Contains response data for the listMetricDefinitions operation.

ElasticPoolsListMetricsResponse

ElasticPoolsListMetricsResponse: MetricListResult & object

Contains response data for the listMetrics operation.

ElasticPoolsUpdateResponse

ElasticPoolsUpdateResponse: ElasticPool & object

Contains response data for the update operation.

EncryptionProtectorsBeginCreateOrUpdateResponse

EncryptionProtectorsBeginCreateOrUpdateResponse: EncryptionProtector & object

Contains response data for the beginCreateOrUpdate operation.

EncryptionProtectorsCreateOrUpdateResponse

EncryptionProtectorsCreateOrUpdateResponse: EncryptionProtector & object

Contains response data for the createOrUpdate operation.

EncryptionProtectorsGetResponse

EncryptionProtectorsGetResponse: EncryptionProtector & object

Contains response data for the get operation.

EncryptionProtectorsListByServerNextResponse

EncryptionProtectorsListByServerNextResponse: EncryptionProtectorListResult & object

Contains response data for the listByServerNext operation.

EncryptionProtectorsListByServerResponse

EncryptionProtectorsListByServerResponse: EncryptionProtectorListResult & object

Contains response data for the listByServer operation.

ExtendedDatabaseBlobAuditingPoliciesCreateOrUpdateResponse

ExtendedDatabaseBlobAuditingPoliciesCreateOrUpdateResponse: ExtendedDatabaseBlobAuditingPolicy & object

Contains response data for the createOrUpdate operation.

ExtendedDatabaseBlobAuditingPoliciesGetResponse

ExtendedDatabaseBlobAuditingPoliciesGetResponse: ExtendedDatabaseBlobAuditingPolicy & object

Contains response data for the get operation.

ExtendedServerBlobAuditingPoliciesBeginCreateOrUpdateResponse

ExtendedServerBlobAuditingPoliciesBeginCreateOrUpdateResponse: ExtendedServerBlobAuditingPolicy & object

Contains response data for the beginCreateOrUpdate operation.

ExtendedServerBlobAuditingPoliciesCreateOrUpdateResponse

ExtendedServerBlobAuditingPoliciesCreateOrUpdateResponse: ExtendedServerBlobAuditingPolicy & object

Contains response data for the createOrUpdate operation.

ExtendedServerBlobAuditingPoliciesGetResponse

ExtendedServerBlobAuditingPoliciesGetResponse: ExtendedServerBlobAuditingPolicy & object

Contains response data for the get operation.

FailoverGroupReplicationRole

FailoverGroupReplicationRole: "Primary" | "Secondary"

Defines values for FailoverGroupReplicationRole. Possible values include: 'Primary', 'Secondary'

readonly
enum

{string}

FailoverGroupsBeginCreateOrUpdateResponse

FailoverGroupsBeginCreateOrUpdateResponse: FailoverGroup & object

Contains response data for the beginCreateOrUpdate operation.

FailoverGroupsBeginFailoverResponse

FailoverGroupsBeginFailoverResponse: FailoverGroup & object

Contains response data for the beginFailover operation.

FailoverGroupsBeginForceFailoverAllowDataLossResponse

FailoverGroupsBeginForceFailoverAllowDataLossResponse: FailoverGroup & object

Contains response data for the beginForceFailoverAllowDataLoss operation.

FailoverGroupsBeginUpdateResponse

FailoverGroupsBeginUpdateResponse: FailoverGroup & object

Contains response data for the beginUpdate operation.

FailoverGroupsCreateOrUpdateResponse

FailoverGroupsCreateOrUpdateResponse: FailoverGroup & object

Contains response data for the createOrUpdate operation.

FailoverGroupsFailoverResponse

FailoverGroupsFailoverResponse: FailoverGroup & object

Contains response data for the failover operation.

FailoverGroupsForceFailoverAllowDataLossResponse

FailoverGroupsForceFailoverAllowDataLossResponse: FailoverGroup & object

Contains response data for the forceFailoverAllowDataLoss operation.

FailoverGroupsGetResponse

FailoverGroupsGetResponse: FailoverGroup & object

Contains response data for the get operation.

FailoverGroupsListByServerNextResponse

FailoverGroupsListByServerNextResponse: FailoverGroupListResult & object

Contains response data for the listByServerNext operation.

FailoverGroupsListByServerResponse

FailoverGroupsListByServerResponse: FailoverGroupListResult & object

Contains response data for the listByServer operation.

FailoverGroupsUpdateResponse

FailoverGroupsUpdateResponse: FailoverGroup & object

Contains response data for the update operation.

FirewallRulesCreateOrUpdateResponse

FirewallRulesCreateOrUpdateResponse: FirewallRule & object

Contains response data for the createOrUpdate operation.

FirewallRulesGetResponse

FirewallRulesGetResponse: FirewallRule & object

Contains response data for the get operation.

FirewallRulesListByServerResponse

FirewallRulesListByServerResponse: FirewallRuleListResult & object

Contains response data for the listByServer operation.

GeoBackupPoliciesCreateOrUpdateResponse

GeoBackupPoliciesCreateOrUpdateResponse: GeoBackupPolicy & object

Contains response data for the createOrUpdate operation.

GeoBackupPoliciesGetResponse

GeoBackupPoliciesGetResponse: GeoBackupPolicy & object

Contains response data for the get operation.

GeoBackupPoliciesListByDatabaseResponse

GeoBackupPoliciesListByDatabaseResponse: GeoBackupPolicyListResult & object

Contains response data for the listByDatabase operation.

GeoBackupPolicyState

GeoBackupPolicyState: "Disabled" | "Enabled"

Defines values for GeoBackupPolicyState. Possible values include: 'Disabled', 'Enabled'

readonly
enum

{string}

IdentityType

IdentityType: "SystemAssigned"

Defines values for IdentityType. Possible values include: 'SystemAssigned'

readonly
enum

{string}

InstanceFailoverGroupReplicationRole

InstanceFailoverGroupReplicationRole: "Primary" | "Secondary"

Defines values for InstanceFailoverGroupReplicationRole. Possible values include: 'Primary', 'Secondary'

readonly
enum

{string}

InstanceFailoverGroupsBeginCreateOrUpdateResponse

InstanceFailoverGroupsBeginCreateOrUpdateResponse: InstanceFailoverGroup & object

Contains response data for the beginCreateOrUpdate operation.

InstanceFailoverGroupsBeginFailoverResponse

InstanceFailoverGroupsBeginFailoverResponse: InstanceFailoverGroup & object

Contains response data for the beginFailover operation.

InstanceFailoverGroupsBeginForceFailoverAllowDataLossResponse

InstanceFailoverGroupsBeginForceFailoverAllowDataLossResponse: InstanceFailoverGroup & object

Contains response data for the beginForceFailoverAllowDataLoss operation.

InstanceFailoverGroupsCreateOrUpdateResponse

InstanceFailoverGroupsCreateOrUpdateResponse: InstanceFailoverGroup & object

Contains response data for the createOrUpdate operation.

InstanceFailoverGroupsFailoverResponse

InstanceFailoverGroupsFailoverResponse: InstanceFailoverGroup & object

Contains response data for the failover operation.

InstanceFailoverGroupsForceFailoverAllowDataLossResponse

InstanceFailoverGroupsForceFailoverAllowDataLossResponse: InstanceFailoverGroup & object

Contains response data for the forceFailoverAllowDataLoss operation.

InstanceFailoverGroupsGetResponse

InstanceFailoverGroupsGetResponse: InstanceFailoverGroup & object

Contains response data for the get operation.

InstanceFailoverGroupsListByLocationNextResponse

InstanceFailoverGroupsListByLocationNextResponse: InstanceFailoverGroupListResult & object

Contains response data for the listByLocationNext operation.

InstanceFailoverGroupsListByLocationResponse

InstanceFailoverGroupsListByLocationResponse: InstanceFailoverGroupListResult & object

Contains response data for the listByLocation operation.

JobAgentState

JobAgentState: "Creating" | "Ready" | "Updating" | "Deleting" | "Disabled"

Defines values for JobAgentState. Possible values include: 'Creating', 'Ready', 'Updating', 'Deleting', 'Disabled'

readonly
enum

{string}

JobAgentsBeginCreateOrUpdateResponse

JobAgentsBeginCreateOrUpdateResponse: JobAgent & object

Contains response data for the beginCreateOrUpdate operation.

JobAgentsBeginUpdateResponse

JobAgentsBeginUpdateResponse: JobAgent & object

Contains response data for the beginUpdate operation.

JobAgentsCreateOrUpdateResponse

JobAgentsCreateOrUpdateResponse: JobAgent & object

Contains response data for the createOrUpdate operation.

JobAgentsGetResponse

JobAgentsGetResponse: JobAgent & object

Contains response data for the get operation.

JobAgentsListByServerNextResponse

JobAgentsListByServerNextResponse: JobAgentListResult & object

Contains response data for the listByServerNext operation.

JobAgentsListByServerResponse

JobAgentsListByServerResponse: JobAgentListResult & object

Contains response data for the listByServer operation.

JobAgentsUpdateResponse

JobAgentsUpdateResponse: JobAgent & object

Contains response data for the update operation.

JobCredentialsCreateOrUpdateResponse

JobCredentialsCreateOrUpdateResponse: JobCredential & object

Contains response data for the createOrUpdate operation.

JobCredentialsGetResponse

JobCredentialsGetResponse: JobCredential & object

Contains response data for the get operation.

JobCredentialsListByAgentNextResponse

JobCredentialsListByAgentNextResponse: JobCredentialListResult & object

Contains response data for the listByAgentNext operation.

JobCredentialsListByAgentResponse

JobCredentialsListByAgentResponse: JobCredentialListResult & object

Contains response data for the listByAgent operation.

JobExecutionLifecycle

JobExecutionLifecycle: "Created" | "InProgress" | "WaitingForChildJobExecutions" | "WaitingForRetry" | "Succeeded" | "SucceededWithSkipped" | "Failed" | "TimedOut" | "Canceled" | "Skipped"

Defines values for JobExecutionLifecycle. Possible values include: 'Created', 'InProgress', 'WaitingForChildJobExecutions', 'WaitingForRetry', 'Succeeded', 'SucceededWithSkipped', 'Failed', 'TimedOut', 'Canceled', 'Skipped'

readonly
enum

{string}

JobExecutionsBeginCreateOrUpdateResponse

JobExecutionsBeginCreateOrUpdateResponse: JobExecution & object

Contains response data for the beginCreateOrUpdate operation.

JobExecutionsBeginCreateResponse

JobExecutionsBeginCreateResponse: JobExecution & object

Contains response data for the beginCreate operation.

JobExecutionsCreateOrUpdateResponse

JobExecutionsCreateOrUpdateResponse: JobExecution & object

Contains response data for the createOrUpdate operation.

JobExecutionsCreateResponse

JobExecutionsCreateResponse: JobExecution & object

Contains response data for the create operation.

JobExecutionsGetResponse

JobExecutionsGetResponse: JobExecution & object

Contains response data for the get operation.

JobExecutionsListByAgentNextResponse

JobExecutionsListByAgentNextResponse: JobExecutionListResult & object

Contains response data for the listByAgentNext operation.

JobExecutionsListByAgentResponse

JobExecutionsListByAgentResponse: JobExecutionListResult & object

Contains response data for the listByAgent operation.

JobExecutionsListByJobNextResponse

JobExecutionsListByJobNextResponse: JobExecutionListResult & object

Contains response data for the listByJobNext operation.

JobExecutionsListByJobResponse

JobExecutionsListByJobResponse: JobExecutionListResult & object

Contains response data for the listByJob operation.

JobScheduleType

JobScheduleType: "Once" | "Recurring"

Defines values for JobScheduleType. Possible values include: 'Once', 'Recurring'

readonly
enum

{string}

JobStepActionSource

JobStepActionSource: "Inline"

Defines values for JobStepActionSource. Possible values include: 'Inline'

readonly
enum

{string}

JobStepActionType

JobStepActionType: "TSql"

Defines values for JobStepActionType. Possible values include: 'TSql'

readonly
enum

{string}

JobStepExecutionsGetResponse

JobStepExecutionsGetResponse: JobExecution & object

Contains response data for the get operation.

JobStepExecutionsListByJobExecutionNextResponse

JobStepExecutionsListByJobExecutionNextResponse: JobExecutionListResult & object

Contains response data for the listByJobExecutionNext operation.

JobStepExecutionsListByJobExecutionResponse

JobStepExecutionsListByJobExecutionResponse: JobExecutionListResult & object

Contains response data for the listByJobExecution operation.

JobStepOutputType

JobStepOutputType: "SqlDatabase"

Defines values for JobStepOutputType. Possible values include: 'SqlDatabase'

readonly
enum

{string}

JobStepsCreateOrUpdateResponse

JobStepsCreateOrUpdateResponse: JobStep & object

Contains response data for the createOrUpdate operation.

JobStepsGetByVersionResponse

JobStepsGetByVersionResponse: JobStep & object

Contains response data for the getByVersion operation.

JobStepsGetResponse

JobStepsGetResponse: JobStep & object

Contains response data for the get operation.

JobStepsListByJobNextResponse

JobStepsListByJobNextResponse: JobStepListResult & object

Contains response data for the listByJobNext operation.

JobStepsListByJobResponse

JobStepsListByJobResponse: JobStepListResult & object

Contains response data for the listByJob operation.

JobStepsListByVersionNextResponse

JobStepsListByVersionNextResponse: JobStepListResult & object

Contains response data for the listByVersionNext operation.

JobStepsListByVersionResponse

JobStepsListByVersionResponse: JobStepListResult & object

Contains response data for the listByVersion operation.

JobTargetExecutionsGetResponse

JobTargetExecutionsGetResponse: JobExecution & object

Contains response data for the get operation.

JobTargetExecutionsListByJobExecutionNextResponse

JobTargetExecutionsListByJobExecutionNextResponse: JobExecutionListResult & object

Contains response data for the listByJobExecutionNext operation.

JobTargetExecutionsListByJobExecutionResponse

JobTargetExecutionsListByJobExecutionResponse: JobExecutionListResult & object

Contains response data for the listByJobExecution operation.

JobTargetExecutionsListByStepNextResponse

JobTargetExecutionsListByStepNextResponse: JobExecutionListResult & object

Contains response data for the listByStepNext operation.

JobTargetExecutionsListByStepResponse

JobTargetExecutionsListByStepResponse: JobExecutionListResult & object

Contains response data for the listByStep operation.

JobTargetGroupMembershipType

JobTargetGroupMembershipType: "Include" | "Exclude"

Defines values for JobTargetGroupMembershipType. Possible values include: 'Include', 'Exclude'

readonly
enum

{string}

JobTargetGroupsCreateOrUpdateResponse

JobTargetGroupsCreateOrUpdateResponse: JobTargetGroup & object

Contains response data for the createOrUpdate operation.

JobTargetGroupsGetResponse

JobTargetGroupsGetResponse: JobTargetGroup & object

Contains response data for the get operation.

JobTargetGroupsListByAgentNextResponse

JobTargetGroupsListByAgentNextResponse: JobTargetGroupListResult & object

Contains response data for the listByAgentNext operation.

JobTargetGroupsListByAgentResponse

JobTargetGroupsListByAgentResponse: JobTargetGroupListResult & object

Contains response data for the listByAgent operation.

JobTargetType

JobTargetType: "TargetGroup" | "SqlDatabase" | "SqlElasticPool" | "SqlShardMap" | "SqlServer"

Defines values for JobTargetType. Possible values include: 'TargetGroup', 'SqlDatabase', 'SqlElasticPool', 'SqlShardMap', 'SqlServer'

readonly
enum

{string}

JobVersionsGetResponse

JobVersionsGetResponse: JobVersion & object

Contains response data for the get operation.

JobVersionsListByJobNextResponse

JobVersionsListByJobNextResponse: JobVersionListResult & object

Contains response data for the listByJobNext operation.

JobVersionsListByJobResponse

JobVersionsListByJobResponse: JobVersionListResult & object

Contains response data for the listByJob operation.

JobsCreateOrUpdateResponse

JobsCreateOrUpdateResponse: Job & object

Contains response data for the createOrUpdate operation.

JobsGetResponse

JobsGetResponse: Job & object

Contains response data for the get operation.

JobsListByAgentNextResponse

JobsListByAgentNextResponse: JobListResult & object

Contains response data for the listByAgentNext operation.

JobsListByAgentResponse

JobsListByAgentResponse: JobListResult & object

Contains response data for the listByAgent operation.

LogSizeUnit

LogSizeUnit: "Megabytes" | "Gigabytes" | "Terabytes" | "Petabytes" | "Percent"

Defines values for LogSizeUnit. Possible values include: 'Megabytes', 'Gigabytes', 'Terabytes', 'Petabytes', 'Percent'

readonly
enum

{string}

LongTermRetentionBackupsGetResponse

LongTermRetentionBackupsGetResponse: LongTermRetentionBackup & object

Contains response data for the get operation.

LongTermRetentionBackupsListByDatabaseNextResponse

LongTermRetentionBackupsListByDatabaseNextResponse: LongTermRetentionBackupListResult & object

Contains response data for the listByDatabaseNext operation.

LongTermRetentionBackupsListByDatabaseResponse

LongTermRetentionBackupsListByDatabaseResponse: LongTermRetentionBackupListResult & object

Contains response data for the listByDatabase operation.

LongTermRetentionBackupsListByLocationNextResponse

LongTermRetentionBackupsListByLocationNextResponse: LongTermRetentionBackupListResult & object

Contains response data for the listByLocationNext operation.

LongTermRetentionBackupsListByLocationResponse

LongTermRetentionBackupsListByLocationResponse: LongTermRetentionBackupListResult & object

Contains response data for the listByLocation operation.

LongTermRetentionBackupsListByServerNextResponse

LongTermRetentionBackupsListByServerNextResponse: LongTermRetentionBackupListResult & object

Contains response data for the listByServerNext operation.

LongTermRetentionBackupsListByServerResponse

LongTermRetentionBackupsListByServerResponse: LongTermRetentionBackupListResult & object

Contains response data for the listByServer operation.

LongTermRetentionDatabaseState

LongTermRetentionDatabaseState: "All" | "Live" | "Deleted"

Defines values for LongTermRetentionDatabaseState. Possible values include: 'All', 'Live', 'Deleted'

readonly
enum

{string}

ManagedBackupShortTermRetentionPoliciesBeginCreateOrUpdateResponse

ManagedBackupShortTermRetentionPoliciesBeginCreateOrUpdateResponse: ManagedBackupShortTermRetentionPolicy & object

Contains response data for the beginCreateOrUpdate operation.

ManagedBackupShortTermRetentionPoliciesBeginUpdateResponse

ManagedBackupShortTermRetentionPoliciesBeginUpdateResponse: ManagedBackupShortTermRetentionPolicy & object

Contains response data for the beginUpdate operation.

ManagedBackupShortTermRetentionPoliciesCreateOrUpdateResponse

ManagedBackupShortTermRetentionPoliciesCreateOrUpdateResponse: ManagedBackupShortTermRetentionPolicy & object

Contains response data for the createOrUpdate operation.

ManagedBackupShortTermRetentionPoliciesGetResponse

ManagedBackupShortTermRetentionPoliciesGetResponse: ManagedBackupShortTermRetentionPolicy & object

Contains response data for the get operation.

ManagedBackupShortTermRetentionPoliciesListByDatabaseNextResponse

ManagedBackupShortTermRetentionPoliciesListByDatabaseNextResponse: ManagedBackupShortTermRetentionPolicyListResult & object

Contains response data for the listByDatabaseNext operation.

ManagedBackupShortTermRetentionPoliciesListByDatabaseResponse

ManagedBackupShortTermRetentionPoliciesListByDatabaseResponse: ManagedBackupShortTermRetentionPolicyListResult & object

Contains response data for the listByDatabase operation.

ManagedBackupShortTermRetentionPoliciesUpdateResponse

ManagedBackupShortTermRetentionPoliciesUpdateResponse: ManagedBackupShortTermRetentionPolicy & object

Contains response data for the update operation.

ManagedDatabaseCreateMode

ManagedDatabaseCreateMode: "Default" | "RestoreExternalBackup" | "PointInTimeRestore" | "Recovery"

Defines values for ManagedDatabaseCreateMode. Possible values include: 'Default', 'RestoreExternalBackup', 'PointInTimeRestore', 'Recovery'

readonly
enum

{string}

ManagedDatabaseSecurityAlertPoliciesCreateOrUpdateResponse

ManagedDatabaseSecurityAlertPoliciesCreateOrUpdateResponse: ManagedDatabaseSecurityAlertPolicy & object

Contains response data for the createOrUpdate operation.

ManagedDatabaseSecurityAlertPoliciesGetResponse

ManagedDatabaseSecurityAlertPoliciesGetResponse: ManagedDatabaseSecurityAlertPolicy & object

Contains response data for the get operation.

ManagedDatabaseSecurityAlertPoliciesListByDatabaseNextResponse

ManagedDatabaseSecurityAlertPoliciesListByDatabaseNextResponse: ManagedDatabaseSecurityAlertPolicyListResult & object

Contains response data for the listByDatabaseNext operation.

ManagedDatabaseSecurityAlertPoliciesListByDatabaseResponse

ManagedDatabaseSecurityAlertPoliciesListByDatabaseResponse: ManagedDatabaseSecurityAlertPolicyListResult & object

Contains response data for the listByDatabase operation.

ManagedDatabaseSensitivityLabelsCreateOrUpdateResponse

ManagedDatabaseSensitivityLabelsCreateOrUpdateResponse: SensitivityLabel & object

Contains response data for the createOrUpdate operation.

ManagedDatabaseSensitivityLabelsGetResponse

ManagedDatabaseSensitivityLabelsGetResponse: SensitivityLabel & object

Contains response data for the get operation.

ManagedDatabaseSensitivityLabelsListCurrentByDatabaseNextResponse

ManagedDatabaseSensitivityLabelsListCurrentByDatabaseNextResponse: SensitivityLabelListResult & object

Contains response data for the listCurrentByDatabaseNext operation.

ManagedDatabaseSensitivityLabelsListCurrentByDatabaseResponse

ManagedDatabaseSensitivityLabelsListCurrentByDatabaseResponse: SensitivityLabelListResult & object

Contains response data for the listCurrentByDatabase operation.

ManagedDatabaseSensitivityLabelsListRecommendedByDatabaseNextResponse

ManagedDatabaseSensitivityLabelsListRecommendedByDatabaseNextResponse: SensitivityLabelListResult & object

Contains response data for the listRecommendedByDatabaseNext operation.

ManagedDatabaseSensitivityLabelsListRecommendedByDatabaseResponse

ManagedDatabaseSensitivityLabelsListRecommendedByDatabaseResponse: SensitivityLabelListResult & object

Contains response data for the listRecommendedByDatabase operation.

ManagedDatabaseStatus

ManagedDatabaseStatus: "Online" | "Offline" | "Shutdown" | "Creating" | "Inaccessible" | "Updating"

Defines values for ManagedDatabaseStatus. Possible values include: 'Online', 'Offline', 'Shutdown', 'Creating', 'Inaccessible', 'Updating'

readonly
enum

{string}

ManagedDatabaseVulnerabilityAssessmentRuleBaselinesCreateOrUpdateResponse

ManagedDatabaseVulnerabilityAssessmentRuleBaselinesCreateOrUpdateResponse: DatabaseVulnerabilityAssessmentRuleBaseline & object

Contains response data for the createOrUpdate operation.

ManagedDatabaseVulnerabilityAssessmentRuleBaselinesGetResponse

ManagedDatabaseVulnerabilityAssessmentRuleBaselinesGetResponse: DatabaseVulnerabilityAssessmentRuleBaseline & object

Contains response data for the get operation.

ManagedDatabaseVulnerabilityAssessmentScansExportMethodResponse

ManagedDatabaseVulnerabilityAssessmentScansExportMethodResponse: DatabaseVulnerabilityAssessmentScansExport & object

Contains response data for the exportMethod operation.

ManagedDatabaseVulnerabilityAssessmentScansGetResponse

ManagedDatabaseVulnerabilityAssessmentScansGetResponse: VulnerabilityAssessmentScanRecord & object

Contains response data for the get operation.

ManagedDatabaseVulnerabilityAssessmentScansListByDatabaseNextResponse

ManagedDatabaseVulnerabilityAssessmentScansListByDatabaseNextResponse: VulnerabilityAssessmentScanRecordListResult & object

Contains response data for the listByDatabaseNext operation.

ManagedDatabaseVulnerabilityAssessmentScansListByDatabaseResponse

ManagedDatabaseVulnerabilityAssessmentScansListByDatabaseResponse: VulnerabilityAssessmentScanRecordListResult & object

Contains response data for the listByDatabase operation.

ManagedDatabaseVulnerabilityAssessmentsCreateOrUpdateResponse

ManagedDatabaseVulnerabilityAssessmentsCreateOrUpdateResponse: DatabaseVulnerabilityAssessment & object

Contains response data for the createOrUpdate operation.

ManagedDatabaseVulnerabilityAssessmentsGetResponse

ManagedDatabaseVulnerabilityAssessmentsGetResponse: DatabaseVulnerabilityAssessment & object

Contains response data for the get operation.

ManagedDatabaseVulnerabilityAssessmentsListByDatabaseNextResponse

ManagedDatabaseVulnerabilityAssessmentsListByDatabaseNextResponse: DatabaseVulnerabilityAssessmentListResult & object

Contains response data for the listByDatabaseNext operation.

ManagedDatabaseVulnerabilityAssessmentsListByDatabaseResponse

ManagedDatabaseVulnerabilityAssessmentsListByDatabaseResponse: DatabaseVulnerabilityAssessmentListResult & object

Contains response data for the listByDatabase operation.

ManagedDatabasesBeginCreateOrUpdateResponse

ManagedDatabasesBeginCreateOrUpdateResponse: ManagedDatabase & object

Contains response data for the beginCreateOrUpdate operation.

ManagedDatabasesBeginUpdateResponse

ManagedDatabasesBeginUpdateResponse: ManagedDatabase & object

Contains response data for the beginUpdate operation.

ManagedDatabasesCreateOrUpdateResponse

ManagedDatabasesCreateOrUpdateResponse: ManagedDatabase & object

Contains response data for the createOrUpdate operation.

ManagedDatabasesGetResponse

ManagedDatabasesGetResponse: ManagedDatabase & object

Contains response data for the get operation.

ManagedDatabasesListByInstanceNextResponse

ManagedDatabasesListByInstanceNextResponse: ManagedDatabaseListResult & object

Contains response data for the listByInstanceNext operation.

ManagedDatabasesListByInstanceResponse

ManagedDatabasesListByInstanceResponse: ManagedDatabaseListResult & object

Contains response data for the listByInstance operation.

ManagedDatabasesUpdateResponse

ManagedDatabasesUpdateResponse: ManagedDatabase & object

Contains response data for the update operation.

ManagedInstanceEncryptionProtectorsBeginCreateOrUpdateResponse

ManagedInstanceEncryptionProtectorsBeginCreateOrUpdateResponse: ManagedInstanceEncryptionProtector & object

Contains response data for the beginCreateOrUpdate operation.

ManagedInstanceEncryptionProtectorsCreateOrUpdateResponse

ManagedInstanceEncryptionProtectorsCreateOrUpdateResponse: ManagedInstanceEncryptionProtector & object

Contains response data for the createOrUpdate operation.

ManagedInstanceEncryptionProtectorsGetResponse

ManagedInstanceEncryptionProtectorsGetResponse: ManagedInstanceEncryptionProtector & object

Contains response data for the get operation.

ManagedInstanceEncryptionProtectorsListByInstanceNextResponse

ManagedInstanceEncryptionProtectorsListByInstanceNextResponse: ManagedInstanceEncryptionProtectorListResult & object

Contains response data for the listByInstanceNext operation.

ManagedInstanceEncryptionProtectorsListByInstanceResponse

ManagedInstanceEncryptionProtectorsListByInstanceResponse: ManagedInstanceEncryptionProtectorListResult & object

Contains response data for the listByInstance operation.

ManagedInstanceKeysBeginCreateOrUpdateResponse

ManagedInstanceKeysBeginCreateOrUpdateResponse: ManagedInstanceKey & object

Contains response data for the beginCreateOrUpdate operation.

ManagedInstanceKeysCreateOrUpdateResponse

ManagedInstanceKeysCreateOrUpdateResponse: ManagedInstanceKey & object

Contains response data for the createOrUpdate operation.

ManagedInstanceKeysGetResponse

ManagedInstanceKeysGetResponse: ManagedInstanceKey & object

Contains response data for the get operation.

ManagedInstanceKeysListByInstanceNextResponse

ManagedInstanceKeysListByInstanceNextResponse: ManagedInstanceKeyListResult & object

Contains response data for the listByInstanceNext operation.

ManagedInstanceKeysListByInstanceResponse

ManagedInstanceKeysListByInstanceResponse: ManagedInstanceKeyListResult & object

Contains response data for the listByInstance operation.

ManagedInstanceProxyOverride

ManagedInstanceProxyOverride: "Proxy" | "Redirect" | "Default"

Defines values for ManagedInstanceProxyOverride. Possible values include: 'Proxy', 'Redirect', 'Default'

readonly
enum

{string}

ManagedInstanceVulnerabilityAssessmentsCreateOrUpdateResponse

ManagedInstanceVulnerabilityAssessmentsCreateOrUpdateResponse: ManagedInstanceVulnerabilityAssessment & object

Contains response data for the createOrUpdate operation.

ManagedInstanceVulnerabilityAssessmentsGetResponse

ManagedInstanceVulnerabilityAssessmentsGetResponse: ManagedInstanceVulnerabilityAssessment & object

Contains response data for the get operation.

ManagedInstanceVulnerabilityAssessmentsListByInstanceNextResponse

ManagedInstanceVulnerabilityAssessmentsListByInstanceNextResponse: ManagedInstanceVulnerabilityAssessmentListResult & object

Contains response data for the listByInstanceNext operation.

ManagedInstanceVulnerabilityAssessmentsListByInstanceResponse

ManagedInstanceVulnerabilityAssessmentsListByInstanceResponse: ManagedInstanceVulnerabilityAssessmentListResult & object

Contains response data for the listByInstance operation.

ManagedInstancesBeginCreateOrUpdateResponse

ManagedInstancesBeginCreateOrUpdateResponse: ManagedInstance & object

Contains response data for the beginCreateOrUpdate operation.

ManagedInstancesBeginUpdateResponse

ManagedInstancesBeginUpdateResponse: ManagedInstance & object

Contains response data for the beginUpdate operation.

ManagedInstancesCreateOrUpdateResponse

ManagedInstancesCreateOrUpdateResponse: ManagedInstance & object

Contains response data for the createOrUpdate operation.

ManagedInstancesGetResponse

ManagedInstancesGetResponse: ManagedInstance & object

Contains response data for the get operation.

ManagedInstancesListByResourceGroupNextResponse

ManagedInstancesListByResourceGroupNextResponse: ManagedInstanceListResult & object

Contains response data for the listByResourceGroupNext operation.

ManagedInstancesListByResourceGroupResponse

ManagedInstancesListByResourceGroupResponse: ManagedInstanceListResult & object

Contains response data for the listByResourceGroup operation.

ManagedInstancesListNextResponse

ManagedInstancesListNextResponse: ManagedInstanceListResult & object

Contains response data for the listNext operation.

ManagedInstancesListResponse

ManagedInstancesListResponse: ManagedInstanceListResult & object

Contains response data for the list operation.

ManagedInstancesUpdateResponse

ManagedInstancesUpdateResponse: ManagedInstance & object

Contains response data for the update operation.

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesBeginCreateOrUpdateResponse

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesBeginCreateOrUpdateResponse: ManagedBackupShortTermRetentionPolicy & object

Contains response data for the beginCreateOrUpdate operation.

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesBeginUpdateResponse

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesBeginUpdateResponse: ManagedBackupShortTermRetentionPolicy & object

Contains response data for the beginUpdate operation.

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesCreateOrUpdateResponse

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesCreateOrUpdateResponse: ManagedBackupShortTermRetentionPolicy & object

Contains response data for the createOrUpdate operation.

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesGetResponse

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesGetResponse: ManagedBackupShortTermRetentionPolicy & object

Contains response data for the get operation.

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesListByRestorableDroppedDatabaseNextResponse

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesListByRestorableDroppedDatabaseNextResponse: ManagedBackupShortTermRetentionPolicyListResult & object

Contains response data for the listByRestorableDroppedDatabaseNext operation.

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesListByRestorableDroppedDatabaseResponse

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesListByRestorableDroppedDatabaseResponse: ManagedBackupShortTermRetentionPolicyListResult & object

Contains response data for the listByRestorableDroppedDatabase operation.

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesUpdateResponse

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesUpdateResponse: ManagedBackupShortTermRetentionPolicy & object

Contains response data for the update operation.

ManagedServerSecurityAlertPoliciesBeginCreateOrUpdateResponse

ManagedServerSecurityAlertPoliciesBeginCreateOrUpdateResponse: ManagedServerSecurityAlertPolicy & object

Contains response data for the beginCreateOrUpdate operation.

ManagedServerSecurityAlertPoliciesCreateOrUpdateResponse

ManagedServerSecurityAlertPoliciesCreateOrUpdateResponse: ManagedServerSecurityAlertPolicy & object

Contains response data for the createOrUpdate operation.

ManagedServerSecurityAlertPoliciesGetResponse

ManagedServerSecurityAlertPoliciesGetResponse: ManagedServerSecurityAlertPolicy & object

Contains response data for the get operation.

ManagedServerSecurityAlertPoliciesListByInstanceNextResponse

ManagedServerSecurityAlertPoliciesListByInstanceNextResponse: ManagedServerSecurityAlertPolicyListResult & object

Contains response data for the listByInstanceNext operation.

ManagedServerSecurityAlertPoliciesListByInstanceResponse

ManagedServerSecurityAlertPoliciesListByInstanceResponse: ManagedServerSecurityAlertPolicyListResult & object

Contains response data for the listByInstance operation.

ManagementOperationState

ManagementOperationState: "Pending" | "InProgress" | "Succeeded" | "Failed" | "CancelInProgress" | "Cancelled"

Defines values for ManagementOperationState. Possible values include: 'Pending', 'InProgress', 'Succeeded', 'Failed', 'CancelInProgress', 'Cancelled'

readonly
enum

{string}

MaxSizeUnit

MaxSizeUnit: "Megabytes" | "Gigabytes" | "Terabytes" | "Petabytes"

Defines values for MaxSizeUnit. Possible values include: 'Megabytes', 'Gigabytes', 'Terabytes', 'Petabytes'

readonly
enum

{string}

OperationOrigin

OperationOrigin: "user" | "system"

Defines values for OperationOrigin. Possible values include: 'user', 'system'

readonly
enum

{string}

OperationsListNextResponse

OperationsListNextResponse: OperationListResult & object

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: OperationListResult & object

Contains response data for the list operation.

PerformanceLevelUnit

PerformanceLevelUnit: "DTU" | "VCores"

Defines values for PerformanceLevelUnit. Possible values include: 'DTU', 'VCores'

readonly
enum

{string}

PrimaryAggregationType

PrimaryAggregationType: "None" | "Average" | "Count" | "Minimum" | "Maximum" | "Total"

Defines values for PrimaryAggregationType. Possible values include: 'None', 'Average', 'Count', 'Minimum', 'Maximum', 'Total'

readonly
enum

{string}

ProvisioningState

ProvisioningState: "Created" | "InProgress" | "Succeeded" | "Failed" | "Canceled"

Defines values for ProvisioningState. Possible values include: 'Created', 'InProgress', 'Succeeded', 'Failed', 'Canceled'

readonly
enum

{string}

ReadOnlyEndpointFailoverPolicy

ReadOnlyEndpointFailoverPolicy: "Disabled" | "Enabled"

Defines values for ReadOnlyEndpointFailoverPolicy. Possible values include: 'Disabled', 'Enabled'

readonly
enum

{string}

ReadWriteEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy: "Manual" | "Automatic"

Defines values for ReadWriteEndpointFailoverPolicy. Possible values include: 'Manual', 'Automatic'

readonly
enum

{string}

RecommendedElasticPoolsGetResponse

RecommendedElasticPoolsGetResponse: RecommendedElasticPool & object

Contains response data for the get operation.

RecommendedElasticPoolsListByServerResponse

RecommendedElasticPoolsListByServerResponse: RecommendedElasticPoolListResult & object

Contains response data for the listByServer operation.

RecommendedElasticPoolsListMetricsResponse

RecommendedElasticPoolsListMetricsResponse: RecommendedElasticPoolListMetricsResult & object

Contains response data for the listMetrics operation.

RecommendedIndexAction

RecommendedIndexAction: "Create" | "Drop" | "Rebuild"

Defines values for RecommendedIndexAction. Possible values include: 'Create', 'Drop', 'Rebuild'

readonly
enum

{string}

RecommendedIndexState

RecommendedIndexState: "Active" | "Pending" | "Executing" | "Verifying" | "Pending Revert" | "Reverting" | "Reverted" | "Ignored" | "Expired" | "Blocked" | "Success"

Defines values for RecommendedIndexState. Possible values include: 'Active', 'Pending', 'Executing', 'Verifying', 'Pending Revert', 'Reverting', 'Reverted', 'Ignored', 'Expired', 'Blocked', 'Success'

readonly
enum

{string}

RecommendedIndexType

RecommendedIndexType: "CLUSTERED" | "NONCLUSTERED" | "COLUMNSTORE" | "CLUSTERED COLUMNSTORE"

Defines values for RecommendedIndexType. Possible values include: 'CLUSTERED', 'NONCLUSTERED', 'COLUMNSTORE', 'CLUSTERED COLUMNSTORE'

readonly
enum

{string}

RecoverableDatabasesGetResponse

RecoverableDatabasesGetResponse: RecoverableDatabase & object

Contains response data for the get operation.

RecoverableDatabasesListByServerResponse

RecoverableDatabasesListByServerResponse: RecoverableDatabaseListResult & object

Contains response data for the listByServer operation.

RecoverableManagedDatabasesGetResponse

RecoverableManagedDatabasesGetResponse: RecoverableManagedDatabase & object

Contains response data for the get operation.

RecoverableManagedDatabasesListByInstanceNextResponse

RecoverableManagedDatabasesListByInstanceNextResponse: RecoverableManagedDatabaseListResult & object

Contains response data for the listByInstanceNext operation.

RecoverableManagedDatabasesListByInstanceResponse

RecoverableManagedDatabasesListByInstanceResponse: RecoverableManagedDatabaseListResult & object

Contains response data for the listByInstance operation.

ReplicationLinksGetResponse

ReplicationLinksGetResponse: ReplicationLink & object

Contains response data for the get operation.

ReplicationLinksListByDatabaseResponse

ReplicationLinksListByDatabaseResponse: ReplicationLinkListResult & object

Contains response data for the listByDatabase operation.

ReplicationRole

ReplicationRole: "Primary" | "Secondary" | "NonReadableSecondary" | "Source" | "Copy"

Defines values for ReplicationRole. Possible values include: 'Primary', 'Secondary', 'NonReadableSecondary', 'Source', 'Copy'

readonly
enum

{string}

ReplicationState

ReplicationState: "PENDING" | "SEEDING" | "CATCH_UP" | "SUSPENDED"

Defines values for ReplicationState. Possible values include: 'PENDING', 'SEEDING', 'CATCH_UP', 'SUSPENDED'

readonly
enum

{string}

RestorableDroppedDatabasesGetResponse

RestorableDroppedDatabasesGetResponse: RestorableDroppedDatabase & object

Contains response data for the get operation.

RestorableDroppedDatabasesListByServerResponse

RestorableDroppedDatabasesListByServerResponse: RestorableDroppedDatabaseListResult & object

Contains response data for the listByServer operation.

RestorableDroppedManagedDatabasesGetResponse

RestorableDroppedManagedDatabasesGetResponse: RestorableDroppedManagedDatabase & object

Contains response data for the get operation.

RestorableDroppedManagedDatabasesListByInstanceNextResponse

RestorableDroppedManagedDatabasesListByInstanceNextResponse: RestorableDroppedManagedDatabaseListResult & object

Contains response data for the listByInstanceNext operation.

RestorableDroppedManagedDatabasesListByInstanceResponse

RestorableDroppedManagedDatabasesListByInstanceResponse: RestorableDroppedManagedDatabaseListResult & object

Contains response data for the listByInstance operation.

RestorePointType

RestorePointType: "CONTINUOUS" | "DISCRETE"

Defines values for RestorePointType. Possible values include: 'CONTINUOUS', 'DISCRETE'

readonly
enum

{string}

RestorePointsBeginCreateResponse

RestorePointsBeginCreateResponse: RestorePoint & object

Contains response data for the beginCreate operation.

RestorePointsCreateResponse

RestorePointsCreateResponse: RestorePoint & object

Contains response data for the create operation.

RestorePointsGetResponse

RestorePointsGetResponse: RestorePoint & object

Contains response data for the get operation.

RestorePointsListByDatabaseResponse

RestorePointsListByDatabaseResponse: RestorePointListResult & object

Contains response data for the listByDatabase operation.

SampleName

SampleName: "AdventureWorksLT" | "WideWorldImportersStd" | "WideWorldImportersFull"

Defines values for SampleName. Possible values include: 'AdventureWorksLT', 'WideWorldImportersStd', 'WideWorldImportersFull'

readonly
enum

{string}

SecurityAlertPolicyEmailAccountAdmins

SecurityAlertPolicyEmailAccountAdmins: "Enabled" | "Disabled"

Defines values for SecurityAlertPolicyEmailAccountAdmins. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

SecurityAlertPolicyState

SecurityAlertPolicyState: "New" | "Enabled" | "Disabled"

Defines values for SecurityAlertPolicyState. Possible values include: 'New', 'Enabled', 'Disabled'

readonly
enum

{string}

SecurityAlertPolicyUseServerDefault

SecurityAlertPolicyUseServerDefault: "Enabled" | "Disabled"

Defines values for SecurityAlertPolicyUseServerDefault. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

SensitivityLabelSource

SensitivityLabelSource: "current" | "recommended"

Defines values for SensitivityLabelSource. Possible values include: 'current', 'recommended'

readonly
enum

{string}

SensitivityLabelsCreateOrUpdateResponse

SensitivityLabelsCreateOrUpdateResponse: SensitivityLabel & object

Contains response data for the createOrUpdate operation.

SensitivityLabelsGetResponse

SensitivityLabelsGetResponse: SensitivityLabel & object

Contains response data for the get operation.

SensitivityLabelsListCurrentByDatabaseNextResponse

SensitivityLabelsListCurrentByDatabaseNextResponse: SensitivityLabelListResult & object

Contains response data for the listCurrentByDatabaseNext operation.

SensitivityLabelsListCurrentByDatabaseResponse

SensitivityLabelsListCurrentByDatabaseResponse: SensitivityLabelListResult & object

Contains response data for the listCurrentByDatabase operation.

SensitivityLabelsListRecommendedByDatabaseNextResponse

SensitivityLabelsListRecommendedByDatabaseNextResponse: SensitivityLabelListResult & object

Contains response data for the listRecommendedByDatabaseNext operation.

SensitivityLabelsListRecommendedByDatabaseResponse

SensitivityLabelsListRecommendedByDatabaseResponse: SensitivityLabelListResult & object

Contains response data for the listRecommendedByDatabase operation.

ServerAutomaticTuningGetResponse

ServerAutomaticTuningGetResponse: ServerAutomaticTuning & object

Contains response data for the get operation.

ServerAutomaticTuningUpdateResponse

ServerAutomaticTuningUpdateResponse: ServerAutomaticTuning & object

Contains response data for the update operation.

ServerAzureADAdministratorsBeginCreateOrUpdateResponse

ServerAzureADAdministratorsBeginCreateOrUpdateResponse: ServerAzureADAdministrator & object

Contains response data for the beginCreateOrUpdate operation.

ServerAzureADAdministratorsBeginDeleteMethodResponse

ServerAzureADAdministratorsBeginDeleteMethodResponse: ServerAzureADAdministrator & object

Contains response data for the beginDeleteMethod operation.

ServerAzureADAdministratorsCreateOrUpdateResponse

ServerAzureADAdministratorsCreateOrUpdateResponse: ServerAzureADAdministrator & object

Contains response data for the createOrUpdate operation.

ServerAzureADAdministratorsDeleteMethodResponse

ServerAzureADAdministratorsDeleteMethodResponse: ServerAzureADAdministrator & object

Contains response data for the deleteMethod operation.

ServerAzureADAdministratorsGetResponse

ServerAzureADAdministratorsGetResponse: ServerAzureADAdministrator & object

Contains response data for the get operation.

ServerAzureADAdministratorsListByServerResponse

ServerAzureADAdministratorsListByServerResponse: ServerAdministratorListResult & object

Contains response data for the listByServer operation.

ServerBlobAuditingPoliciesBeginCreateOrUpdateResponse

ServerBlobAuditingPoliciesBeginCreateOrUpdateResponse: ServerBlobAuditingPolicy & object

Contains response data for the beginCreateOrUpdate operation.

ServerBlobAuditingPoliciesCreateOrUpdateResponse

ServerBlobAuditingPoliciesCreateOrUpdateResponse: ServerBlobAuditingPolicy & object

Contains response data for the createOrUpdate operation.

ServerBlobAuditingPoliciesGetResponse

ServerBlobAuditingPoliciesGetResponse: ServerBlobAuditingPolicy & object

Contains response data for the get operation.

ServerCommunicationLinksBeginCreateOrUpdateResponse

ServerCommunicationLinksBeginCreateOrUpdateResponse: ServerCommunicationLink & object

Contains response data for the beginCreateOrUpdate operation.

ServerCommunicationLinksCreateOrUpdateResponse

ServerCommunicationLinksCreateOrUpdateResponse: ServerCommunicationLink & object

Contains response data for the createOrUpdate operation.

ServerCommunicationLinksGetResponse

ServerCommunicationLinksGetResponse: ServerCommunicationLink & object

Contains response data for the get operation.

ServerCommunicationLinksListByServerResponse

ServerCommunicationLinksListByServerResponse: ServerCommunicationLinkListResult & object

Contains response data for the listByServer operation.

ServerConnectionPoliciesCreateOrUpdateResponse

ServerConnectionPoliciesCreateOrUpdateResponse: ServerConnectionPolicy & object

Contains response data for the createOrUpdate operation.

ServerConnectionPoliciesGetResponse

ServerConnectionPoliciesGetResponse: ServerConnectionPolicy & object

Contains response data for the get operation.

ServerConnectionType

ServerConnectionType: "Default" | "Proxy" | "Redirect"

Defines values for ServerConnectionType. Possible values include: 'Default', 'Proxy', 'Redirect'

readonly
enum

{string}

ServerDnsAliasesBeginCreateOrUpdateResponse

ServerDnsAliasesBeginCreateOrUpdateResponse: ServerDnsAlias & object

Contains response data for the beginCreateOrUpdate operation.

ServerDnsAliasesCreateOrUpdateResponse

ServerDnsAliasesCreateOrUpdateResponse: ServerDnsAlias & object

Contains response data for the createOrUpdate operation.

ServerDnsAliasesGetResponse

ServerDnsAliasesGetResponse: ServerDnsAlias & object

Contains response data for the get operation.

ServerDnsAliasesListByServerNextResponse

ServerDnsAliasesListByServerNextResponse: ServerDnsAliasListResult & object

Contains response data for the listByServerNext operation.

ServerDnsAliasesListByServerResponse

ServerDnsAliasesListByServerResponse: ServerDnsAliasListResult & object

Contains response data for the listByServer operation.

ServerKeyType

ServerKeyType: "ServiceManaged" | "AzureKeyVault"

Defines values for ServerKeyType. Possible values include: 'ServiceManaged', 'AzureKeyVault'

readonly
enum

{string}

ServerKeysBeginCreateOrUpdateResponse

ServerKeysBeginCreateOrUpdateResponse: ServerKey & object

Contains response data for the beginCreateOrUpdate operation.

ServerKeysCreateOrUpdateResponse

ServerKeysCreateOrUpdateResponse: ServerKey & object

Contains response data for the createOrUpdate operation.

ServerKeysGetResponse

ServerKeysGetResponse: ServerKey & object

Contains response data for the get operation.

ServerKeysListByServerNextResponse

ServerKeysListByServerNextResponse: ServerKeyListResult & object

Contains response data for the listByServerNext operation.

ServerKeysListByServerResponse

ServerKeysListByServerResponse: ServerKeyListResult & object

Contains response data for the listByServer operation.

ServerSecurityAlertPoliciesBeginCreateOrUpdateResponse

ServerSecurityAlertPoliciesBeginCreateOrUpdateResponse: ServerSecurityAlertPolicy & object

Contains response data for the beginCreateOrUpdate operation.

ServerSecurityAlertPoliciesCreateOrUpdateResponse

ServerSecurityAlertPoliciesCreateOrUpdateResponse: ServerSecurityAlertPolicy & object

Contains response data for the createOrUpdate operation.

ServerSecurityAlertPoliciesGetResponse

ServerSecurityAlertPoliciesGetResponse: ServerSecurityAlertPolicy & object

Contains response data for the get operation.

ServerSecurityAlertPoliciesListByServerNextResponse

ServerSecurityAlertPoliciesListByServerNextResponse: LogicalServerSecurityAlertPolicyListResult & object

Contains response data for the listByServerNext operation.

ServerSecurityAlertPoliciesListByServerResponse

ServerSecurityAlertPoliciesListByServerResponse: LogicalServerSecurityAlertPolicyListResult & object

Contains response data for the listByServer operation.

ServerUsagesListByServerResponse

ServerUsagesListByServerResponse: ServerUsageListResult & object

Contains response data for the listByServer operation.

ServerVulnerabilityAssessmentsCreateOrUpdateResponse

ServerVulnerabilityAssessmentsCreateOrUpdateResponse: ServerVulnerabilityAssessment & object

Contains response data for the createOrUpdate operation.

ServerVulnerabilityAssessmentsGetResponse

ServerVulnerabilityAssessmentsGetResponse: ServerVulnerabilityAssessment & object

Contains response data for the get operation.

ServerVulnerabilityAssessmentsListByServerNextResponse

ServerVulnerabilityAssessmentsListByServerNextResponse: ServerVulnerabilityAssessmentListResult & object

Contains response data for the listByServerNext operation.

ServerVulnerabilityAssessmentsListByServerResponse

ServerVulnerabilityAssessmentsListByServerResponse: ServerVulnerabilityAssessmentListResult & object

Contains response data for the listByServer operation.

ServersBeginCreateOrUpdateResponse

ServersBeginCreateOrUpdateResponse: Server & object

Contains response data for the beginCreateOrUpdate operation.

ServersBeginUpdateResponse

ServersBeginUpdateResponse: Server & object

Contains response data for the beginUpdate operation.

ServersCheckNameAvailabilityResponse

ServersCheckNameAvailabilityResponse: CheckNameAvailabilityResponse & object

Contains response data for the checkNameAvailability operation.

ServersCreateOrUpdateResponse

ServersCreateOrUpdateResponse: Server & object

Contains response data for the createOrUpdate operation.

ServersGetResponse

ServersGetResponse: Server & object

Contains response data for the get operation.

ServersListByResourceGroupNextResponse

ServersListByResourceGroupNextResponse: ServerListResult & object

Contains response data for the listByResourceGroupNext operation.

ServersListByResourceGroupResponse

ServersListByResourceGroupResponse: ServerListResult & object

Contains response data for the listByResourceGroup operation.

ServersListNextResponse

ServersListNextResponse: ServerListResult & object

Contains response data for the listNext operation.

ServersListResponse

ServersListResponse: ServerListResult & object

Contains response data for the list operation.

ServersUpdateResponse

ServersUpdateResponse: Server & object

Contains response data for the update operation.

ServiceObjectiveName

ServiceObjectiveName: "System" | "System0" | "System1" | "System2" | "System3" | "System4" | "System2L" | "System3L" | "System4L" | "Free" | "Basic" | "S0" | "S1" | "S2" | "S3" | "S4" | "S6" | "S7" | "S9" | "S12" | "P1" | "P2" | "P3" | "P4" | "P6" | "P11" | "P15" | "PRS1" | "PRS2" | "PRS4" | "PRS6" | "DW100" | "DW200" | "DW300" | "DW400" | "DW500" | "DW600" | "DW1000" | "DW1200" | "DW1000c" | "DW1500" | "DW1500c" | "DW2000" | "DW2000c" | "DW3000" | "DW2500c" | "DW3000c" | "DW6000" | "DW5000c" | "DW6000c" | "DW7500c" | "DW10000c" | "DW15000c" | "DW30000c" | "DS100" | "DS200" | "DS300" | "DS400" | "DS500" | "DS600" | "DS1000" | "DS1200" | "DS1500" | "DS2000" | "ElasticPool"

Defines values for ServiceObjectiveName. Possible values include: 'System', 'System0', 'System1', 'System2', 'System3', 'System4', 'System2L', 'System3L', 'System4L', 'Free', 'Basic', 'S0', 'S1', 'S2', 'S3', 'S4', 'S6', 'S7', 'S9', 'S12', 'P1', 'P2', 'P3', 'P4', 'P6', 'P11', 'P15', 'PRS1', 'PRS2', 'PRS4', 'PRS6', 'DW100', 'DW200', 'DW300', 'DW400', 'DW500', 'DW600', 'DW1000', 'DW1200', 'DW1000c', 'DW1500', 'DW1500c', 'DW2000', 'DW2000c', 'DW3000', 'DW2500c', 'DW3000c', 'DW6000', 'DW5000c', 'DW6000c', 'DW7500c', 'DW10000c', 'DW15000c', 'DW30000c', 'DS100', 'DS200', 'DS300', 'DS400', 'DS500', 'DS600', 'DS1000', 'DS1200', 'DS1500', 'DS2000', 'ElasticPool'

readonly
enum

{string}

ServiceObjectivesGetResponse

ServiceObjectivesGetResponse: ServiceObjective & object

Contains response data for the get operation.

ServiceObjectivesListByServerResponse

ServiceObjectivesListByServerResponse: ServiceObjectiveListResult & object

Contains response data for the listByServer operation.

ServiceTierAdvisorsGetResponse

ServiceTierAdvisorsGetResponse: ServiceTierAdvisor & object

Contains response data for the get operation.

ServiceTierAdvisorsListByDatabaseResponse

ServiceTierAdvisorsListByDatabaseResponse: ServiceTierAdvisorListResult & object

Contains response data for the listByDatabase operation.

StorageKeyType

StorageKeyType: "StorageAccessKey" | "SharedAccessKey"

Defines values for StorageKeyType. Possible values include: 'StorageAccessKey', 'SharedAccessKey'

readonly
enum

{string}

SubscriptionUsagesGetResponse

SubscriptionUsagesGetResponse: SubscriptionUsage & object

Contains response data for the get operation.

SubscriptionUsagesListByLocationNextResponse

SubscriptionUsagesListByLocationNextResponse: SubscriptionUsageListResult & object

Contains response data for the listByLocationNext operation.

SubscriptionUsagesListByLocationResponse

SubscriptionUsagesListByLocationResponse: SubscriptionUsageListResult & object

Contains response data for the listByLocation operation.

SyncAgentState

SyncAgentState: "Online" | "Offline" | "NeverConnected"

Defines values for SyncAgentState. Possible values include: 'Online', 'Offline', 'NeverConnected'

readonly
enum

{string}

SyncAgentsBeginCreateOrUpdateResponse

SyncAgentsBeginCreateOrUpdateResponse: SyncAgent & object

Contains response data for the beginCreateOrUpdate operation.

SyncAgentsCreateOrUpdateResponse

SyncAgentsCreateOrUpdateResponse: SyncAgent & object

Contains response data for the createOrUpdate operation.

SyncAgentsGenerateKeyResponse

SyncAgentsGenerateKeyResponse: SyncAgentKeyProperties & object

Contains response data for the generateKey operation.

SyncAgentsGetResponse

SyncAgentsGetResponse: SyncAgent & object

Contains response data for the get operation.

SyncAgentsListByServerNextResponse

SyncAgentsListByServerNextResponse: SyncAgentListResult & object

Contains response data for the listByServerNext operation.

SyncAgentsListByServerResponse

SyncAgentsListByServerResponse: SyncAgentListResult & object

Contains response data for the listByServer operation.

SyncAgentsListLinkedDatabasesNextResponse

SyncAgentsListLinkedDatabasesNextResponse: SyncAgentLinkedDatabaseListResult & object

Contains response data for the listLinkedDatabasesNext operation.

SyncAgentsListLinkedDatabasesResponse

SyncAgentsListLinkedDatabasesResponse: SyncAgentLinkedDatabaseListResult & object

Contains response data for the listLinkedDatabases operation.

SyncConflictResolutionPolicy

SyncConflictResolutionPolicy: "HubWin" | "MemberWin"

Defines values for SyncConflictResolutionPolicy. Possible values include: 'HubWin', 'MemberWin'

readonly
enum

{string}

SyncDirection

SyncDirection: "Bidirectional" | "OneWayMemberToHub" | "OneWayHubToMember"

Defines values for SyncDirection. Possible values include: 'Bidirectional', 'OneWayMemberToHub', 'OneWayHubToMember'

readonly
enum

{string}

SyncGroupLogType

SyncGroupLogType: "All" | "Error" | "Warning" | "Success"

Defines values for SyncGroupLogType. Possible values include: 'All', 'Error', 'Warning', 'Success'

readonly
enum

{string}

SyncGroupState

SyncGroupState: "NotReady" | "Error" | "Warning" | "Progressing" | "Good"

Defines values for SyncGroupState. Possible values include: 'NotReady', 'Error', 'Warning', 'Progressing', 'Good'

readonly
enum

{string}

SyncGroupsBeginCreateOrUpdateResponse

SyncGroupsBeginCreateOrUpdateResponse: SyncGroup & object

Contains response data for the beginCreateOrUpdate operation.

SyncGroupsBeginUpdateResponse

SyncGroupsBeginUpdateResponse: SyncGroup & object

Contains response data for the beginUpdate operation.

SyncGroupsCreateOrUpdateResponse

SyncGroupsCreateOrUpdateResponse: SyncGroup & object

Contains response data for the createOrUpdate operation.

SyncGroupsGetResponse

SyncGroupsGetResponse: SyncGroup & object

Contains response data for the get operation.

SyncGroupsListByDatabaseNextResponse

SyncGroupsListByDatabaseNextResponse: SyncGroupListResult & object

Contains response data for the listByDatabaseNext operation.

SyncGroupsListByDatabaseResponse

SyncGroupsListByDatabaseResponse: SyncGroupListResult & object

Contains response data for the listByDatabase operation.

SyncGroupsListHubSchemasNextResponse

SyncGroupsListHubSchemasNextResponse: SyncFullSchemaPropertiesListResult & object

Contains response data for the listHubSchemasNext operation.

SyncGroupsListHubSchemasResponse

SyncGroupsListHubSchemasResponse: SyncFullSchemaPropertiesListResult & object

Contains response data for the listHubSchemas operation.

SyncGroupsListLogsNextResponse

SyncGroupsListLogsNextResponse: SyncGroupLogListResult & object

Contains response data for the listLogsNext operation.

SyncGroupsListLogsResponse

SyncGroupsListLogsResponse: SyncGroupLogListResult & object

Contains response data for the listLogs operation.

SyncGroupsListSyncDatabaseIdsNextResponse

SyncGroupsListSyncDatabaseIdsNextResponse: SyncDatabaseIdListResult & object

Contains response data for the listSyncDatabaseIdsNext operation.

SyncGroupsListSyncDatabaseIdsResponse

SyncGroupsListSyncDatabaseIdsResponse: SyncDatabaseIdListResult & object

Contains response data for the listSyncDatabaseIds operation.

SyncGroupsUpdateResponse

SyncGroupsUpdateResponse: SyncGroup & object

Contains response data for the update operation.

SyncMemberDbType

SyncMemberDbType: "AzureSqlDatabase" | "SqlServerDatabase"

Defines values for SyncMemberDbType. Possible values include: 'AzureSqlDatabase', 'SqlServerDatabase'

readonly
enum

{string}

SyncMemberState

SyncMemberState: "SyncInProgress" | "SyncSucceeded" | "SyncFailed" | "DisabledTombstoneCleanup" | "DisabledBackupRestore" | "SyncSucceededWithWarnings" | "SyncCancelling" | "SyncCancelled" | "UnProvisioned" | "Provisioning" | "Provisioned" | "ProvisionFailed" | "DeProvisioning" | "DeProvisioned" | "DeProvisionFailed" | "Reprovisioning" | "ReprovisionFailed" | "UnReprovisioned"

Defines values for SyncMemberState. Possible values include: 'SyncInProgress', 'SyncSucceeded', 'SyncFailed', 'DisabledTombstoneCleanup', 'DisabledBackupRestore', 'SyncSucceededWithWarnings', 'SyncCancelling', 'SyncCancelled', 'UnProvisioned', 'Provisioning', 'Provisioned', 'ProvisionFailed', 'DeProvisioning', 'DeProvisioned', 'DeProvisionFailed', 'Reprovisioning', 'ReprovisionFailed', 'UnReprovisioned'

readonly
enum

{string}

SyncMembersBeginCreateOrUpdateResponse

SyncMembersBeginCreateOrUpdateResponse: SyncMember & object

Contains response data for the beginCreateOrUpdate operation.

SyncMembersBeginUpdateResponse

SyncMembersBeginUpdateResponse: SyncMember & object

Contains response data for the beginUpdate operation.

SyncMembersCreateOrUpdateResponse

SyncMembersCreateOrUpdateResponse: SyncMember & object

Contains response data for the createOrUpdate operation.

SyncMembersGetResponse

SyncMembersGetResponse: SyncMember & object

Contains response data for the get operation.

SyncMembersListBySyncGroupNextResponse

SyncMembersListBySyncGroupNextResponse: SyncMemberListResult & object

Contains response data for the listBySyncGroupNext operation.

SyncMembersListBySyncGroupResponse

SyncMembersListBySyncGroupResponse: SyncMemberListResult & object

Contains response data for the listBySyncGroup operation.

SyncMembersListMemberSchemasNextResponse

SyncMembersListMemberSchemasNextResponse: SyncFullSchemaPropertiesListResult & object

Contains response data for the listMemberSchemasNext operation.

SyncMembersListMemberSchemasResponse

SyncMembersListMemberSchemasResponse: SyncFullSchemaPropertiesListResult & object

Contains response data for the listMemberSchemas operation.

SyncMembersUpdateResponse

SyncMembersUpdateResponse: SyncMember & object

Contains response data for the update operation.

TransparentDataEncryptionActivitiesListByConfigurationResponse

TransparentDataEncryptionActivitiesListByConfigurationResponse: TransparentDataEncryptionActivityListResult & object

Contains response data for the listByConfiguration operation.

TransparentDataEncryptionActivityStatus

TransparentDataEncryptionActivityStatus: "Encrypting" | "Decrypting"

Defines values for TransparentDataEncryptionActivityStatus. Possible values include: 'Encrypting', 'Decrypting'

readonly
enum

{string}

TransparentDataEncryptionStatus

TransparentDataEncryptionStatus: "Enabled" | "Disabled"

Defines values for TransparentDataEncryptionStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

TransparentDataEncryptionsCreateOrUpdateResponse

TransparentDataEncryptionsCreateOrUpdateResponse: TransparentDataEncryption & object

Contains response data for the createOrUpdate operation.

TransparentDataEncryptionsGetResponse

TransparentDataEncryptionsGetResponse: TransparentDataEncryption & object

Contains response data for the get operation.

Type

Type: "All" | "Error" | "Warning" | "Success"

Defines values for Type. Possible values include: 'All', 'Error', 'Warning', 'Success'

readonly
enum

{string}

UnitDefinitionType

UnitDefinitionType: "Count" | "Bytes" | "Seconds" | "Percent" | "CountPerSecond" | "BytesPerSecond"

Defines values for UnitDefinitionType. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond'

readonly
enum

{string}

UnitType

UnitType: "count" | "bytes" | "seconds" | "percent" | "countPerSecond" | "bytesPerSecond"

Defines values for UnitType. Possible values include: 'count', 'bytes', 'seconds', 'percent', 'countPerSecond', 'bytesPerSecond'

readonly
enum

{string}

VirtualClustersBeginUpdateResponse

VirtualClustersBeginUpdateResponse: VirtualCluster & object

Contains response data for the beginUpdate operation.

VirtualClustersGetResponse

VirtualClustersGetResponse: VirtualCluster & object

Contains response data for the get operation.

VirtualClustersListByResourceGroupNextResponse

VirtualClustersListByResourceGroupNextResponse: VirtualClusterListResult & object

Contains response data for the listByResourceGroupNext operation.

VirtualClustersListByResourceGroupResponse

VirtualClustersListByResourceGroupResponse: VirtualClusterListResult & object

Contains response data for the listByResourceGroup operation.

VirtualClustersListNextResponse

VirtualClustersListNextResponse: VirtualClusterListResult & object

Contains response data for the listNext operation.

VirtualClustersListResponse

VirtualClustersListResponse: VirtualClusterListResult & object

Contains response data for the list operation.

VirtualClustersUpdateResponse

VirtualClustersUpdateResponse: VirtualCluster & object

Contains response data for the update operation.

VirtualNetworkRuleState

VirtualNetworkRuleState: "Initializing" | "InProgress" | "Ready" | "Deleting" | "Unknown"

Defines values for VirtualNetworkRuleState. Possible values include: 'Initializing', 'InProgress', 'Ready', 'Deleting', 'Unknown'

readonly
enum

{string}

VirtualNetworkRulesBeginCreateOrUpdateResponse

VirtualNetworkRulesBeginCreateOrUpdateResponse: VirtualNetworkRule & object

Contains response data for the beginCreateOrUpdate operation.

VirtualNetworkRulesCreateOrUpdateResponse

VirtualNetworkRulesCreateOrUpdateResponse: VirtualNetworkRule & object

Contains response data for the createOrUpdate operation.

VirtualNetworkRulesGetResponse

VirtualNetworkRulesGetResponse: VirtualNetworkRule & object

Contains response data for the get operation.

VirtualNetworkRulesListByServerNextResponse

VirtualNetworkRulesListByServerNextResponse: VirtualNetworkRuleListResult & object

Contains response data for the listByServerNext operation.

VirtualNetworkRulesListByServerResponse

VirtualNetworkRulesListByServerResponse: VirtualNetworkRuleListResult & object

Contains response data for the listByServer operation.

VulnerabilityAssessmentPolicyBaselineName

VulnerabilityAssessmentPolicyBaselineName: "master" | "default"

Defines values for VulnerabilityAssessmentPolicyBaselineName. Possible values include: 'master', 'default'

readonly
enum

{string}

VulnerabilityAssessmentScanState

VulnerabilityAssessmentScanState: "Passed" | "Failed" | "FailedToRun" | "InProgress"

Defines values for VulnerabilityAssessmentScanState. Possible values include: 'Passed', 'Failed', 'FailedToRun', 'InProgress'

readonly
enum

{string}

VulnerabilityAssessmentScanTriggerType

VulnerabilityAssessmentScanTriggerType: "OnDemand" | "Recurring"

Defines values for VulnerabilityAssessmentScanTriggerType. Possible values include: 'OnDemand', 'Recurring'

readonly
enum

{string}

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const AutomaticTuningOptions

AutomaticTuningOptions: object

Automatic tuning properties for individual advisors.

Optional actualState

Automatic tuning option actual state. Possible values include: 'Off', 'On' NOTE: This property will not be serialized. It can only be populated by the server.

Optional desiredState

Automatic tuning option desired state. Possible values include: 'Off', 'On', 'Default'

Optional reasonCode

reasonCode: undefined | number

Reason code if desired and actual state are different. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reasonDesc

Reason description if desired and actual state are different. Possible values include: 'Default', 'Disabled', 'AutoConfigured', 'InheritedFromServer', 'QueryStoreOff', 'QueryStoreReadOnly', 'NotSupported' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AutomaticTuningOptions"

type

type: object

className

className: string = "AutomaticTuningOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actualState

actualState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "actualState"

type

type: object

allowedValues

allowedValues: string[] = ["Off","On"]

name

name: "Enum" = "Enum"

desiredState

desiredState: object

serializedName

serializedName: string = "desiredState"

type

type: object

allowedValues

allowedValues: string[] = ["Off","On","Default"]

name

name: "Enum" = "Enum"

reasonCode

reasonCode: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "reasonCode"

type

type: object

name

name: "Number" = "Number"

reasonDesc

reasonDesc: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "reasonDesc"

type

type: object

allowedValues

allowedValues: string[] = ["Default","Disabled","AutoConfigured","InheritedFromServer","QueryStoreOff","QueryStoreReadOnly","NotSupported"]

name

name: "Enum" = "Enum"

Const AutomaticTuningServerOptions

AutomaticTuningServerOptions: object

Automatic tuning properties for individual advisors.

Optional actualState

Automatic tuning option actual state. Possible values include: 'Off', 'On' NOTE: This property will not be serialized. It can only be populated by the server.

Optional desiredState

Automatic tuning option desired state. Possible values include: 'Off', 'On', 'Default'

Optional reasonCode

reasonCode: undefined | number

Reason code if desired and actual state are different. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reasonDesc

Reason description if desired and actual state are different. Possible values include: 'Default', 'Disabled', 'AutoConfigured' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AutomaticTuningServerOptions"

type

type: object

className

className: string = "AutomaticTuningServerOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actualState

actualState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "actualState"

type

type: object

allowedValues

allowedValues: string[] = ["Off","On"]

name

name: "Enum" = "Enum"

desiredState

desiredState: object

serializedName

serializedName: string = "desiredState"

type

type: object

allowedValues

allowedValues: string[] = ["Off","On","Default"]

name

name: "Enum" = "Enum"

reasonCode

reasonCode: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "reasonCode"

type

type: object

name

name: "Number" = "Number"

reasonDesc

reasonDesc: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "reasonDesc"

type

type: object

allowedValues

allowedValues: string[] = ["Default","Disabled","AutoConfigured"]

name

name: "Enum" = "Enum"

Const BackupLongTermRetentionPolicy

BackupLongTermRetentionPolicy: object

A long term retention policy.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional monthlyRetention

monthlyRetention: undefined | string

The monthly retention policy for an LTR backup in an ISO 8601 format.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BackupLongTermRetentionPolicy"

Optional weekOfYear

weekOfYear: undefined | number

The week of year to take the yearly backup in an ISO 8601 format.

Optional weeklyRetention

weeklyRetention: undefined | string

The weekly retention policy for an LTR backup in an ISO 8601 format.

Optional yearlyRetention

yearlyRetention: undefined | string

The yearly retention policy for an LTR backup in an ISO 8601 format.

type

type: object

className

className: string = "BackupLongTermRetentionPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

monthlyRetention

monthlyRetention: object

serializedName

serializedName: string = "properties.monthlyRetention"

type

type: object

name

name: "String" = "String"

weekOfYear

weekOfYear: object

serializedName

serializedName: string = "properties.weekOfYear"

type

type: object

name

name: "Number" = "Number"

weeklyRetention

weeklyRetention: object

serializedName

serializedName: string = "properties.weeklyRetention"

type

type: object

name

name: "String" = "String"

yearlyRetention

yearlyRetention: object

serializedName

serializedName: string = "properties.yearlyRetention"

type

type: object

name

name: "String" = "String"

Const BackupShortTermRetentionPolicy

BackupShortTermRetentionPolicy: object

A short term retention policy.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional retentionDays

retentionDays: undefined | number

The backup retention period in days. This is how many days Point-in-Time Restore will be supported.

serializedName

serializedName: string = "BackupShortTermRetentionPolicy"

type

type: object

className

className: string = "BackupShortTermRetentionPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

retentionDays

retentionDays: object

serializedName

serializedName: string = "properties.retentionDays"

type

type: object

name

name: "Number" = "Number"

Const BackupShortTermRetentionPolicyListResult

BackupShortTermRetentionPolicyListResult: object
interface

A list of short term retention policies.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BackupShortTermRetentionPolicyListResult"

__@iterator

  • __@iterator(): IterableIterator<BackupShortTermRetentionPolicy>
  • Iterator

    Returns IterableIterator<BackupShortTermRetentionPolicy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<BackupShortTermRetentionPolicy>[]): BackupShortTermRetentionPolicy[]
  • concat(...items: (T | ConcatArray<T>)[]): BackupShortTermRetentionPolicy[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BackupShortTermRetentionPolicy>[]

      Additional items to add to the end of array1.

    Returns BackupShortTermRetentionPolicy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BackupShortTermRetentionPolicy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, BackupShortTermRetentionPolicy]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BackupShortTermRetentionPolicy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: BackupShortTermRetentionPolicy, index: number, array: BackupShortTermRetentionPolicy[]): boolean
        • Parameters

          • value: BackupShortTermRetentionPolicy
          • index: number
          • array: BackupShortTermRetentionPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BackupShortTermRetentionPolicy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BackupShortTermRetentionPolicy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BackupShortTermRetentionPolicy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: BackupShortTermRetentionPolicy

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackupShortTermRetentionPolicy, index: number, array: BackupShortTermRetentionPolicy[]): boolean
        • Parameters

          • value: BackupShortTermRetentionPolicy
          • index: number
          • array: BackupShortTermRetentionPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackupShortTermRetentionPolicy, index: number, array: BackupShortTermRetentionPolicy[]): any
        • Parameters

          • value: BackupShortTermRetentionPolicy
          • index: number
          • array: BackupShortTermRetentionPolicy[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BackupShortTermRetentionPolicy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BackupShortTermRetentionPolicy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: BackupShortTermRetentionPolicy

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: BackupShortTermRetentionPolicy, index: number, obj: BackupShortTermRetentionPolicy[]): boolean
        • Parameters

          • this: void
          • value: BackupShortTermRetentionPolicy
          • index: number
          • obj: BackupShortTermRetentionPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: BackupShortTermRetentionPolicy, index: number, obj: BackupShortTermRetentionPolicy[]): boolean
        • Parameters

          • value: BackupShortTermRetentionPolicy
          • index: number
          • obj: BackupShortTermRetentionPolicy[]

          Returns boolean

    • Optional thisArg: any

    Returns BackupShortTermRetentionPolicy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: BackupShortTermRetentionPolicy, index: number, obj: BackupShortTermRetentionPolicy[]): boolean
        • Parameters

          • value: BackupShortTermRetentionPolicy
          • index: number
          • obj: BackupShortTermRetentionPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: BackupShortTermRetentionPolicy, index: number, array: BackupShortTermRetentionPolicy[]): void
        • Parameters

          • value: BackupShortTermRetentionPolicy
          • index: number
          • array: BackupShortTermRetentionPolicy[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BackupShortTermRetentionPolicy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BackupShortTermRetentionPolicy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BackupShortTermRetentionPolicy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BackupShortTermRetentionPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BackupShortTermRetentionPolicy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BackupShortTermRetentionPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: BackupShortTermRetentionPolicy, index: number, array: BackupShortTermRetentionPolicy[]): U
        • Parameters

          • value: BackupShortTermRetentionPolicy
          • index: number
          • array: BackupShortTermRetentionPolicy[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): BackupShortTermRetentionPolicy | undefined
  • Removes the last element from an array and returns it.

    Returns BackupShortTermRetentionPolicy | undefined

push

  • push(...items: BackupShortTermRetentionPolicy[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: BackupShortTermRetentionPolicy[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): BackupShortTermRetentionPolicy
  • reduce(callbackfn: function, initialValue: BackupShortTermRetentionPolicy): BackupShortTermRetentionPolicy
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackupShortTermRetentionPolicy, currentValue: BackupShortTermRetentionPolicy, currentIndex: number, array: BackupShortTermRetentionPolicy[]): BackupShortTermRetentionPolicy
        • Parameters

          • previousValue: BackupShortTermRetentionPolicy
          • currentValue: BackupShortTermRetentionPolicy
          • currentIndex: number
          • array: BackupShortTermRetentionPolicy[]

          Returns BackupShortTermRetentionPolicy

    Returns BackupShortTermRetentionPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: BackupShortTermRetentionPolicy, currentValue: BackupShortTermRetentionPolicy, currentIndex: number, array: BackupShortTermRetentionPolicy[]): BackupShortTermRetentionPolicy
        • Parameters

          • previousValue: BackupShortTermRetentionPolicy
          • currentValue: BackupShortTermRetentionPolicy
          • currentIndex: number
          • array: BackupShortTermRetentionPolicy[]

          Returns BackupShortTermRetentionPolicy

    • initialValue: BackupShortTermRetentionPolicy

    Returns BackupShortTermRetentionPolicy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackupShortTermRetentionPolicy, currentIndex: number, array: BackupShortTermRetentionPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: BackupShortTermRetentionPolicy
          • currentIndex: number
          • array: BackupShortTermRetentionPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): BackupShortTermRetentionPolicy
  • reduceRight(callbackfn: function, initialValue: BackupShortTermRetentionPolicy): BackupShortTermRetentionPolicy
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackupShortTermRetentionPolicy, currentValue: BackupShortTermRetentionPolicy, currentIndex: number, array: BackupShortTermRetentionPolicy[]): BackupShortTermRetentionPolicy
        • Parameters

          • previousValue: BackupShortTermRetentionPolicy
          • currentValue: BackupShortTermRetentionPolicy
          • currentIndex: number
          • array: BackupShortTermRetentionPolicy[]

          Returns BackupShortTermRetentionPolicy

    Returns BackupShortTermRetentionPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: BackupShortTermRetentionPolicy, currentValue: BackupShortTermRetentionPolicy, currentIndex: number, array: BackupShortTermRetentionPolicy[]): BackupShortTermRetentionPolicy
        • Parameters

          • previousValue: BackupShortTermRetentionPolicy
          • currentValue: BackupShortTermRetentionPolicy
          • currentIndex: number
          • array: BackupShortTermRetentionPolicy[]

          Returns BackupShortTermRetentionPolicy

    • initialValue: BackupShortTermRetentionPolicy

    Returns BackupShortTermRetentionPolicy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackupShortTermRetentionPolicy, currentIndex: number, array: BackupShortTermRetentionPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: BackupShortTermRetentionPolicy
          • currentIndex: number
          • array: BackupShortTermRetentionPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): BackupShortTermRetentionPolicy[]
  • Reverses the elements in an Array.

    Returns BackupShortTermRetentionPolicy[]

shift

  • shift(): BackupShortTermRetentionPolicy | undefined
  • Removes the first element from an array and returns it.

    Returns BackupShortTermRetentionPolicy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BackupShortTermRetentionPolicy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BackupShortTermRetentionPolicy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: BackupShortTermRetentionPolicy, index: number, array: BackupShortTermRetentionPolicy[]): boolean
        • Parameters

          • value: BackupShortTermRetentionPolicy
          • index: number
          • array: BackupShortTermRetentionPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): BackupShortTermRetentionPolicy[]
  • splice(start: number, deleteCount: number, ...items: BackupShortTermRetentionPolicy[]): BackupShortTermRetentionPolicy[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BackupShortTermRetentionPolicy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BackupShortTermRetentionPolicy[]

      Elements to insert into the array in place of the deleted elements.

    Returns BackupShortTermRetentionPolicy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: BackupShortTermRetentionPolicy[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BackupShortTermRetentionPolicy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<BackupShortTermRetentionPolicy>
  • Returns an iterable of values in the array

    Returns IterableIterator<BackupShortTermRetentionPolicy>

type

type: object

className

className: string = "BackupShortTermRetentionPolicyListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackupShortTermRetentionPolicy"

name

name: "Composite" = "Composite"

Const CheckNameAvailabilityRequest

CheckNameAvailabilityRequest: object

A request to check whether the specified name for a resource is available.

name

name: string

The name whose availability is to be checked.

serializedName

serializedName: string = "CheckNameAvailabilityRequest"

type

type: object

className

className: string = "CheckNameAvailabilityRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

defaultValue

defaultValue: string = "Microsoft.Sql/servers"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const CheckNameAvailabilityResponse

CheckNameAvailabilityResponse: object

A response indicating whether the specified name for a resource is available.

Optional available

available: undefined | false | true

True if the name is available, otherwise false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional message

message: undefined | string

A message explaining why the name is unavailable. Will be null if the name is available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name whose availability was checked. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

The reason code explaining why the name is unavailable. Will be null if the name is available. Possible values include: 'Invalid', 'AlreadyExists' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CheckNameAvailabilityResponse"

type

type: object

className

className: string = "CheckNameAvailabilityResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

available

available: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "available"

type

type: object

name

name: "Boolean" = "Boolean"

message

message: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reason

reason: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "reason"

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","AlreadyExists"]

name

name: "Enum" = "Enum"

Const CompleteDatabaseRestoreDefinition

CompleteDatabaseRestoreDefinition: object

Contains the information necessary to perform a complete database restore operation.

lastBackupName

lastBackupName: string

The last backup name to apply

serializedName

serializedName: string = "CompleteDatabaseRestoreDefinition"

type

type: object

className

className: string = "CompleteDatabaseRestoreDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lastBackupName

lastBackupName: object

required

required: true = true

serializedName

serializedName: string = "lastBackupName"

type

type: object

name

name: "String" = "String"

Const CreateDatabaseRestorePointDefinition

CreateDatabaseRestorePointDefinition: object

Contains the information necessary to perform a create database restore point operation.

restorePointLabel

restorePointLabel: string

The restore point label to apply

serializedName

serializedName: string = "CreateDatabaseRestorePointDefinition"

type

type: object

className

className: string = "CreateDatabaseRestorePointDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

restorePointLabel

restorePointLabel: object

required

required: true = true

serializedName

serializedName: string = "restorePointLabel"

type

type: object

name

name: "String" = "String"

Const DataMaskingPolicy

DataMaskingPolicy: object

Represents a database data masking policy.

Optional applicationPrincipals

applicationPrincipals: undefined | string

The list of the application principals. This is a legacy parameter and is no longer used. NOTE: This property will not be serialized. It can only be populated by the server.

dataMaskingState

dataMaskingState: DataMaskingState

The state of the data masking policy. Possible values include: 'Disabled', 'Enabled'

Optional exemptPrincipals

exemptPrincipals: undefined | string

The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

The kind of data masking policy. Metadata, used for Azure portal. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the data masking policy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maskingLevel

maskingLevel: undefined | string

The masking level. This is a legacy parameter and is no longer used. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DataMaskingPolicy"

type

type: object

className

className: string = "DataMaskingPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationPrincipals

applicationPrincipals: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.applicationPrincipals"

type

type: object

name

name: "String" = "String"

dataMaskingState

dataMaskingState: object

required

required: true = true

serializedName

serializedName: string = "properties.dataMaskingState"

type

type: object

allowedValues

allowedValues: string[] = ["Disabled","Enabled"]

name

name: "Enum" = "Enum"

exemptPrincipals

exemptPrincipals: object

serializedName

serializedName: string = "properties.exemptPrincipals"

type

type: object

name

name: "String" = "String"

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

maskingLevel

maskingLevel: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maskingLevel"

type

type: object

name

name: "String" = "String"

Const DataMaskingRule

DataMaskingRule: object

Represents a database data masking rule.

Optional aliasName

aliasName: undefined | string

The alias name. This is a legacy parameter and is no longer used.

columnName

columnName: string

The column name on which the data masking rule is applied.

Optional dataMaskingRuleId

dataMaskingRuleId: undefined | string

The rule Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

The kind of Data Masking Rule. Metadata, used for Azure portal. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the data masking rule. NOTE: This property will not be serialized. It can only be populated by the server.

maskingFunction

maskingFunction: DataMaskingFunction

The masking function that is used for the data masking rule. Possible values include: 'Default', 'CCN', 'Email', 'Number', 'SSN', 'Text'

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional numberFrom

numberFrom: undefined | string

The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.

Optional numberTo

numberTo: undefined | string

The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.

Optional prefixSize

prefixSize: undefined | string

If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored.

Optional replacementString

replacementString: undefined | string

If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored.

Optional ruleState

The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. Possible values include: 'Disabled', 'Enabled'

schemaName

schemaName: string

The schema name on which the data masking rule is applied.

serializedName

serializedName: string = "DataMaskingRule"

Optional suffixSize

suffixSize: undefined | string

If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored.

tableName

tableName: string

The table name on which the data masking rule is applied.

type

type: object

className

className: string = "DataMaskingRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aliasName

aliasName: object

serializedName

serializedName: string = "properties.aliasName"

type

type: object

name

name: "String" = "String"

columnName

columnName: object

required

required: true = true

serializedName

serializedName: string = "properties.columnName"

type

type: object

name

name: "String" = "String"

dataMaskingRuleId

dataMaskingRuleId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.id"

type

type: object

name

name: "String" = "String"

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

maskingFunction

maskingFunction: object

required

required: true = true

serializedName

serializedName: string = "properties.maskingFunction"

type

type: object

allowedValues

allowedValues: string[] = ["Default","CCN","Email","Number","SSN","Text"]

name

name: "Enum" = "Enum"

numberFrom

numberFrom: object

serializedName

serializedName: string = "properties.numberFrom"

type

type: object

name

name: "String" = "String"

numberTo

numberTo: object

serializedName

serializedName: string = "properties.numberTo"

type

type: object

name

name: "String" = "String"

prefixSize

prefixSize: object

serializedName

serializedName: string = "properties.prefixSize"

type

type: object

name

name: "String" = "String"

replacementString

replacementString: object

serializedName

serializedName: string = "properties.replacementString"

type

type: object

name

name: "String" = "String"

ruleState

ruleState: object

serializedName

serializedName: string = "properties.ruleState"

type

type: object

allowedValues

allowedValues: string[] = ["Disabled","Enabled"]

name

name: "Enum" = "Enum"

schemaName

schemaName: object

required

required: true = true

serializedName

serializedName: string = "properties.schemaName"

type

type: object

name

name: "String" = "String"

suffixSize

suffixSize: object

serializedName

serializedName: string = "properties.suffixSize"

type

type: object

name

name: "String" = "String"

tableName

tableName: object

required

required: true = true

serializedName

serializedName: string = "properties.tableName"

type

type: object

name

name: "String" = "String"

Const DataMaskingRuleListResult

DataMaskingRuleListResult: object
interface

The response to a list data masking rules request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "DataMaskingRuleListResult"

__@iterator

  • __@iterator(): IterableIterator<DataMaskingRule>
  • Iterator

    Returns IterableIterator<DataMaskingRule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<DataMaskingRule>[]): DataMaskingRule[]
  • concat(...items: (T | ConcatArray<T>)[]): DataMaskingRule[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<DataMaskingRule>[]

      Additional items to add to the end of array1.

    Returns DataMaskingRule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DataMaskingRule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, DataMaskingRule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DataMaskingRule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: DataMaskingRule, index: number, array: DataMaskingRule[]): boolean
        • Parameters

          • value: DataMaskingRule
          • index: number
          • array: DataMaskingRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: DataMaskingRule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DataMaskingRule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DataMaskingRule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: DataMaskingRule

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: DataMaskingRule, index: number, array: DataMaskingRule[]): boolean
        • Parameters

          • value: DataMaskingRule
          • index: number
          • array: DataMaskingRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: DataMaskingRule, index: number, array: DataMaskingRule[]): any
        • Parameters

          • value: DataMaskingRule
          • index: number
          • array: DataMaskingRule[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DataMaskingRule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DataMaskingRule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: DataMaskingRule

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: DataMaskingRule, index: number, obj: DataMaskingRule[]): boolean
        • Parameters

          • this: void
          • value: DataMaskingRule
          • index: number
          • obj: DataMaskingRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: DataMaskingRule, index: number, obj: DataMaskingRule[]): boolean
        • Parameters

          • value: DataMaskingRule
          • index: number
          • obj: DataMaskingRule[]

          Returns boolean

    • Optional thisArg: any

    Returns DataMaskingRule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: DataMaskingRule, index: number, obj: DataMaskingRule[]): boolean
        • Parameters

          • value: DataMaskingRule
          • index: number
          • obj: DataMaskingRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: DataMaskingRule, index: number, array: DataMaskingRule[]): void
        • Parameters

          • value: DataMaskingRule
          • index: number
          • array: DataMaskingRule[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: DataMaskingRule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DataMaskingRule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: DataMaskingRule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DataMaskingRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: DataMaskingRule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DataMaskingRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: DataMaskingRule, index: number, array: DataMaskingRule[]): U
        • Parameters

          • value: DataMaskingRule
          • index: number
          • array: DataMaskingRule[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): DataMaskingRule | undefined
  • Removes the last element from an array and returns it.

    Returns DataMaskingRule | undefined

push

  • push(...items: DataMaskingRule[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: DataMaskingRule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): DataMaskingRule
  • reduce(callbackfn: function, initialValue: DataMaskingRule): DataMaskingRule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: DataMaskingRule, currentValue: DataMaskingRule, currentIndex: number, array: DataMaskingRule[]): DataMaskingRule
        • Parameters

          • previousValue: DataMaskingRule
          • currentValue: DataMaskingRule
          • currentIndex: number
          • array: DataMaskingRule[]

          Returns DataMaskingRule

    Returns DataMaskingRule

  • Parameters

    • callbackfn: function
        • (previousValue: DataMaskingRule, currentValue: DataMaskingRule, currentIndex: number, array: DataMaskingRule[]): DataMaskingRule
        • Parameters

          • previousValue: DataMaskingRule
          • currentValue: DataMaskingRule
          • currentIndex: number
          • array: DataMaskingRule[]

          Returns DataMaskingRule

    • initialValue: DataMaskingRule

    Returns DataMaskingRule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: DataMaskingRule, currentIndex: number, array: DataMaskingRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: DataMaskingRule
          • currentIndex: number
          • array: DataMaskingRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): DataMaskingRule
  • reduceRight(callbackfn: function, initialValue: DataMaskingRule): DataMaskingRule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: DataMaskingRule, currentValue: DataMaskingRule, currentIndex: number, array: DataMaskingRule[]): DataMaskingRule
        • Parameters

          • previousValue: DataMaskingRule
          • currentValue: DataMaskingRule
          • currentIndex: number
          • array: DataMaskingRule[]

          Returns DataMaskingRule

    Returns DataMaskingRule

  • Parameters

    • callbackfn: function
        • (previousValue: DataMaskingRule, currentValue: DataMaskingRule, currentIndex: number, array: DataMaskingRule[]): DataMaskingRule
        • Parameters

          • previousValue: DataMaskingRule
          • currentValue: DataMaskingRule
          • currentIndex: number
          • array: DataMaskingRule[]

          Returns DataMaskingRule

    • initialValue: DataMaskingRule

    Returns DataMaskingRule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: DataMaskingRule, currentIndex: number, array: DataMaskingRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: DataMaskingRule
          • currentIndex: number
          • array: DataMaskingRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): DataMaskingRule[]
  • Reverses the elements in an Array.

    Returns DataMaskingRule[]

shift

  • shift(): DataMaskingRule | undefined
  • Removes the first element from an array and returns it.

    Returns DataMaskingRule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): DataMaskingRule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DataMaskingRule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: DataMaskingRule, index: number, array: DataMaskingRule[]): boolean
        • Parameters

          • value: DataMaskingRule
          • index: number
          • array: DataMaskingRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): DataMaskingRule[]
  • splice(start: number, deleteCount: number, ...items: DataMaskingRule[]): DataMaskingRule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DataMaskingRule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DataMaskingRule[]

      Elements to insert into the array in place of the deleted elements.

    Returns DataMaskingRule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: DataMaskingRule[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: DataMaskingRule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<DataMaskingRule>
  • Returns an iterable of values in the array

    Returns IterableIterator<DataMaskingRule>

type

type: object

className

className: string = "DataMaskingRuleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DataMaskingRule"

name

name: "Composite" = "Composite"

Const Database

Database: object

A database resource.

Optional catalogCollation

catalogCollation: CatalogCollationType

Collation of the metadata catalog. Possible values include: 'DATABASE_DEFAULT', 'SQL_Latin1_General_CP1_CI_AS'

Optional collation

collation: undefined | string

The collation of the database.

Optional createMode

createMode: CreateMode

Specifies the mode of database creation.

Default: regular database creation.

Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.

Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.

PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.

Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.

Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.

RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.

Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. Possible values include: 'Default', 'Copy', 'Secondary', 'PointInTimeRestore', 'Restore', 'Recovery', 'RestoreExternalBackup', 'RestoreExternalBackupSecondary', 'RestoreLongTermRetentionBackup', 'OnlineSecondary'

Optional creationDate

creationDate: Date

The creation date of the database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional currentServiceObjectiveName

currentServiceObjectiveName: undefined | string

The current service level objective name of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional currentSku

currentSku: Sku

The name and tier of the SKU. NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseId

databaseId: undefined | string

The ID of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultSecondaryLocation

defaultSecondaryLocation: undefined | string

The default secondary region for this database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional earliestRestoreDate

earliestRestoreDate: Date

This records the earliest start date and time that restore is available for this database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional elasticPoolId

elasticPoolId: undefined | string

The resource identifier of the elastic pool containing this database.

Optional failoverGroupId

failoverGroupId: undefined | string

Failover Group resource identifier that this database belongs to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of database. This is metadata used for the Azure portal experience. NOTE: This property will not be serialized. It can only be populated by the server.

Optional licenseType

licenseType: DatabaseLicenseType

The license type to apply for this database. Possible values include: 'LicenseIncluded', 'BasePrice'

location

location: string

Resource location.

Optional longTermRetentionBackupResourceId

longTermRetentionBackupResourceId: undefined | string

The resource identifier of the long term retention backup associated with create operation of this database.

Optional managedBy

managedBy: undefined | string

Resource that manages the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxLogSizeBytes

maxLogSizeBytes: undefined | number

The max log size for this database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxSizeBytes

maxSizeBytes: undefined | number

The max size of the database expressed in bytes.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional readScale

The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Possible values include: 'Enabled', 'Disabled'

Optional recoverableDatabaseId

recoverableDatabaseId: undefined | string

The resource identifier of the recoverable database associated with create operation of this database.

Optional recoveryServicesRecoveryPointId

recoveryServicesRecoveryPointId: undefined | string

The resource identifier of the recovery point associated with create operation of this database.

Optional requestedServiceObjectiveName

requestedServiceObjectiveName: undefined | string

The requested service level objective name of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional restorableDroppedDatabaseId

restorableDroppedDatabaseId: undefined | string

The resource identifier of the restorable dropped database associated with create operation of this database.

Optional restorePointInTime

restorePointInTime: Date

Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

Optional sampleName

sampleName: SampleName

The name of the sample schema to apply when creating this database. Possible values include: 'AdventureWorksLT', 'WideWorldImportersStd', 'WideWorldImportersFull'

serializedName

serializedName: string = "Database"

Optional sku

sku: Sku

The name and tier of the SKU.

Optional sourceDatabaseDeletionDate

sourceDatabaseDeletionDate: Date

Specifies the time that the database was deleted.

Optional sourceDatabaseId

sourceDatabaseId: undefined | string

The resource identifier of the source database associated with create operation of this database.

Optional status

The status of the database. Possible values include: 'Online', 'Restoring', 'RecoveryPending', 'Recovering', 'Suspect', 'Offline', 'Standby', 'Shutdown', 'EmergencyMode', 'AutoClosed', 'Copying', 'Creating', 'Inaccessible', 'OfflineSecondary', 'Pausing', 'Paused', 'Resuming', 'Scaling' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

Optional zoneRedundant

zoneRedundant: undefined | false | true

Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

type

type: object

className

className: string = "Database"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

catalogCollation

catalogCollation: object

serializedName

serializedName: string = "properties.catalogCollation"

type

type: object

name

name: "String" = "String"

collation

collation: object

serializedName

serializedName: string = "properties.collation"

type

type: object

name

name: "String" = "String"

createMode

createMode: object

serializedName

serializedName: string = "properties.createMode"

type

type: object

name

name: "String" = "String"

creationDate

creationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationDate"

type

type: object

name

name: "DateTime" = "DateTime"

currentServiceObjectiveName

currentServiceObjectiveName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.currentServiceObjectiveName"

type

type: object

name

name: "String" = "String"

currentSku

currentSku: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.currentSku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

databaseId

databaseId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseId"

type

type: object

name

name: "Uuid" = "Uuid"

defaultSecondaryLocation

defaultSecondaryLocation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultSecondaryLocation"

type

type: object

name

name: "String" = "String"

earliestRestoreDate

earliestRestoreDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.earliestRestoreDate"

type

type: object

name

name: "DateTime" = "DateTime"

elasticPoolId

elasticPoolId: object

serializedName

serializedName: string = "properties.elasticPoolId"

type

type: object

name

name: "String" = "String"

failoverGroupId

failoverGroupId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.failoverGroupId"

type

type: object

name

name: "String" = "String"

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

licenseType

licenseType: object

serializedName

serializedName: string = "properties.licenseType"

type

type: object

name

name: "String" = "String"

longTermRetentionBackupResourceId

longTermRetentionBackupResourceId: object

serializedName

serializedName: string = "properties.longTermRetentionBackupResourceId"

type

type: object

name

name: "String" = "String"

managedBy

managedBy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "managedBy"

type

type: object

name

name: "String" = "String"

maxLogSizeBytes

maxLogSizeBytes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maxLogSizeBytes"

type

type: object

name

name: "Number" = "Number"

maxSizeBytes

maxSizeBytes: object

serializedName

serializedName: string = "properties.maxSizeBytes"

type

type: object

name

name: "Number" = "Number"

readScale

readScale: object

serializedName

serializedName: string = "properties.readScale"

type

type: object

name

name: "String" = "String"

recoverableDatabaseId

recoverableDatabaseId: object

serializedName

serializedName: string = "properties.recoverableDatabaseId"

type

type: object

name

name: "String" = "String"

recoveryServicesRecoveryPointId

recoveryServicesRecoveryPointId: object

serializedName

serializedName: string = "properties.recoveryServicesRecoveryPointId"

type

type: object

name

name: "String" = "String"

requestedServiceObjectiveName

requestedServiceObjectiveName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedServiceObjectiveName"

type

type: object

name

name: "String" = "String"

restorableDroppedDatabaseId

restorableDroppedDatabaseId: object

serializedName

serializedName: string = "properties.restorableDroppedDatabaseId"

type

type: object

name

name: "String" = "String"

restorePointInTime

restorePointInTime: object

serializedName

serializedName: string = "properties.restorePointInTime"

type

type: object

name

name: "DateTime" = "DateTime"

sampleName

sampleName: object

serializedName

serializedName: string = "properties.sampleName"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

sourceDatabaseDeletionDate

sourceDatabaseDeletionDate: object

serializedName

serializedName: string = "properties.sourceDatabaseDeletionDate"

type

type: object

name

name: "DateTime" = "DateTime"

sourceDatabaseId

sourceDatabaseId: object

serializedName

serializedName: string = "properties.sourceDatabaseId"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

zoneRedundant

zoneRedundant: object

serializedName

serializedName: string = "properties.zoneRedundant"

type

type: object

name

name: "Boolean" = "Boolean"

Const DatabaseAutomaticTuning

DatabaseAutomaticTuning: object

Database-level Automatic Tuning.

Optional actualState

actualState: AutomaticTuningMode

Automatic tuning actual state. Possible values include: 'Inherit', 'Custom', 'Auto', 'Unspecified' NOTE: This property will not be serialized. It can only be populated by the server.

Optional desiredState

desiredState: AutomaticTuningMode

Automatic tuning desired state. Possible values include: 'Inherit', 'Custom', 'Auto', 'Unspecified'

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional options

options: undefined | object

Automatic tuning options definition.

serializedName

serializedName: string = "DatabaseAutomaticTuning"

type

type: object

className

className: string = "DatabaseAutomaticTuning"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actualState

actualState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.actualState"

type

type: object

allowedValues

allowedValues: string[] = ["Inherit","Custom","Auto","Unspecified"]

name

name: "Enum" = "Enum"

desiredState

desiredState: object

serializedName

serializedName: string = "properties.desiredState"

type

type: object

allowedValues

allowedValues: string[] = ["Inherit","Custom","Auto","Unspecified"]

name

name: "Enum" = "Enum"

options

options: object

serializedName

serializedName: string = "properties.options"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "AutomaticTuningOptions"

name

name: "Composite" = "Composite"

Const DatabaseBlobAuditingPolicy

DatabaseBlobAuditingPolicy: object

A database blob auditing policy.

Optional auditActionsAndGroups

auditActionsAndGroups: string[]

Specifies the Actions-Groups and Actions to audit.

The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:

BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP.

This above combination is also the set that is configured by default when enabling auditing from the Azure portal.

The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):

APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP

These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.

For more information, see Database-Level Audit Action Groups.

For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES

The general form for defining an action to be audited is: {action} ON {object} BY {principal}

Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.

For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public

For more information, see Database-Level Audit Actions

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isAzureMonitorTargetEnabled

isAzureMonitorTargetEnabled: undefined | false | true

Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.

When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}.

Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview

For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

Optional isStorageSecondaryKeyInUse

isStorageSecondaryKeyInUse: undefined | false | true

Specifies whether storageAccountAccessKey value is the storage's secondary key.

Optional kind

kind: undefined | string

Resource kind. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional retentionDays

retentionDays: undefined | number

Specifies the number of days to keep in the audit logs in the storage account.

serializedName

serializedName: string = "DatabaseBlobAuditingPolicy"

state

Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Possible values include: 'Enabled', 'Disabled'

Optional storageAccountAccessKey

storageAccountAccessKey: undefined | string

Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.

Optional storageAccountSubscriptionId

storageAccountSubscriptionId: undefined | string

Specifies the blob storage subscription Id.

Optional storageEndpoint

storageEndpoint: undefined | string

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.

type

type: object

className

className: string = "DatabaseBlobAuditingPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

auditActionsAndGroups

auditActionsAndGroups: object

serializedName

serializedName: string = "properties.auditActionsAndGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

isAzureMonitorTargetEnabled

isAzureMonitorTargetEnabled: object

serializedName

serializedName: string = "properties.isAzureMonitorTargetEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

isStorageSecondaryKeyInUse

isStorageSecondaryKeyInUse: object

serializedName

serializedName: string = "properties.isStorageSecondaryKeyInUse"

type

type: object

name

name: "Boolean" = "Boolean"

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

retentionDays

retentionDays: object

serializedName

serializedName: string = "properties.retentionDays"

type

type: object

name

name: "Number" = "Number"

state

state: object

required

required: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

storageAccountAccessKey

storageAccountAccessKey: object

serializedName

serializedName: string = "properties.storageAccountAccessKey"

type

type: object

name

name: "String" = "String"

storageAccountSubscriptionId

storageAccountSubscriptionId: object

serializedName

serializedName: string = "properties.storageAccountSubscriptionId"

type

type: object

name

name: "Uuid" = "Uuid"

storageEndpoint

storageEndpoint: object

serializedName

serializedName: string = "properties.storageEndpoint"

type

type: object

name

name: "String" = "String"

Const DatabaseListResult

DatabaseListResult: object
interface

A list of databases.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DatabaseListResult"

__@iterator

  • __@iterator(): IterableIterator<Database>
  • Iterator

    Returns IterableIterator<Database>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Database>[]): Database[]
  • concat(...items: (T | ConcatArray<T>)[]): Database[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Database>[]

      Additional items to add to the end of array1.

    Returns Database[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Database[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Database]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Database]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Database, index: number, array: Database[]): boolean
        • Parameters

          • value: Database
          • index: number
          • array: Database[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Database, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Database

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Database[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Database

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Database, index: number, array: Database[]): boolean
        • Parameters

          • value: Database
          • index: number
          • array: Database[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Database, index: number, array: Database[]): any
        • Parameters

          • value: Database
          • index: number
          • array: Database[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Database[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Database | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Database

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Database, index: number, obj: Database[]): boolean
        • Parameters

          • this: void
          • value: Database
          • index: number
          • obj: Database[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Database, index: number, obj: Database[]): boolean
        • Parameters

          • value: Database
          • index: number
          • obj: Database[]

          Returns boolean

    • Optional thisArg: any

    Returns Database | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Database, index: number, obj: Database[]): boolean
        • Parameters

          • value: Database
          • index: number
          • obj: Database[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Database, index: number, array: Database[]): void
        • Parameters

          • value: Database
          • index: number
          • array: Database[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Database, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Database

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Database, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Database

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Database, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Database

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Database, index: number, array: Database[]): U
        • Parameters

          • value: Database
          • index: number
          • array: Database[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Database | undefined
  • Removes the last element from an array and returns it.

    Returns Database | undefined

push

  • push(...items: Database[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Database[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Database
  • reduce(callbackfn: function, initialValue: Database): Database
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Database, currentValue: Database, currentIndex: number, array: Database[]): Database
        • Parameters

          • previousValue: Database
          • currentValue: Database
          • currentIndex: number
          • array: Database[]

          Returns Database

    Returns Database

  • Parameters

    • callbackfn: function
        • (previousValue: Database, currentValue: Database, currentIndex: number, array: Database[]): Database
        • Parameters

          • previousValue: Database
          • currentValue: Database
          • currentIndex: number
          • array: Database[]

          Returns Database

    • initialValue: Database

    Returns Database

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Database, currentIndex: number, array: Database[]): U
        • Parameters

          • previousValue: U
          • currentValue: Database
          • currentIndex: number
          • array: Database[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Database
  • reduceRight(callbackfn: function, initialValue: Database): Database
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Database, currentValue: Database, currentIndex: number, array: Database[]): Database
        • Parameters

          • previousValue: Database
          • currentValue: Database
          • currentIndex: number
          • array: Database[]

          Returns Database

    Returns Database

  • Parameters

    • callbackfn: function
        • (previousValue: Database, currentValue: Database, currentIndex: number, array: Database[]): Database
        • Parameters

          • previousValue: Database
          • currentValue: Database
          • currentIndex: number
          • array: Database[]

          Returns Database

    • initialValue: Database

    Returns Database

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Database, currentIndex: number, array: Database[]): U
        • Parameters

          • previousValue: U
          • currentValue: Database
          • currentIndex: number
          • array: Database[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Database[]
  • Reverses the elements in an Array.

    Returns Database[]

shift

  • shift(): Database | undefined
  • Removes the first element from an array and returns it.

    Returns Database | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Database[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Database[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Database, index: number, array: Database[]): boolean
        • Parameters

          • value: Database
          • index: number
          • array: Database[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Database[]
  • splice(start: number, deleteCount: number, ...items: Database[]): Database[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Database[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Database[]

      Elements to insert into the array in place of the deleted elements.

    Returns Database[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Database[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Database[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Database>
  • Returns an iterable of values in the array

    Returns IterableIterator<Database>

type

type: object

className

className: string = "DatabaseListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Database"

name

name: "Composite" = "Composite"

Const DatabaseOperation

DatabaseOperation: object

A database operation.

Optional databaseName

databaseName: undefined | string

The name of the database the operation is being performed on. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

The operation description. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorCode

errorCode: undefined | number

The operation error code. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorDescription

errorDescription: undefined | string

The operation error description. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorSeverity

errorSeverity: undefined | number

The operation error severity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional estimatedCompletionTime

estimatedCompletionTime: Date

The estimated completion time of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isCancellable

isCancellable: undefined | false | true

Whether the operation can be cancelled. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isUserError

isUserError: undefined | false | true

Whether or not the error is a user error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operation

operation: undefined | string

The name of operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationFriendlyName

operationFriendlyName: undefined | string

The friendly name of operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional percentComplete

percentComplete: undefined | number

The percentage of the operation completed. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DatabaseOperation"

Optional serverName

serverName: undefined | string

The name of the server. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date

The operation start time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

The operation state. Possible values include: 'Pending', 'InProgress', 'Succeeded', 'Failed', 'CancelInProgress', 'Cancelled' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "DatabaseOperation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

databaseName

databaseName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseName"

type

type: object

name

name: "String" = "String"

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorCode"

type

type: object

name

name: "Number" = "Number"

errorDescription

errorDescription: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorDescription"

type

type: object

name

name: "String" = "String"

errorSeverity

errorSeverity: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorSeverity"

type

type: object

name

name: "Number" = "Number"

estimatedCompletionTime

estimatedCompletionTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.estimatedCompletionTime"

type

type: object

name

name: "DateTime" = "DateTime"

isCancellable

isCancellable: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isCancellable"

type

type: object

name

name: "Boolean" = "Boolean"

isUserError

isUserError: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isUserError"

type

type: object

name

name: "Boolean" = "Boolean"

operation

operation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operation"

type

type: object

name

name: "String" = "String"

operationFriendlyName

operationFriendlyName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operationFriendlyName"

type

type: object

name

name: "String" = "String"

percentComplete

percentComplete: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.percentComplete"

type

type: object

name

name: "Number" = "Number"

serverName

serverName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serverName"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const DatabaseOperationListResult

DatabaseOperationListResult: object
interface

The response to a list database operations request

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DatabaseOperationListResult"

__@iterator

  • __@iterator(): IterableIterator<DatabaseOperation>
  • Iterator

    Returns IterableIterator<DatabaseOperation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<DatabaseOperation>[]): DatabaseOperation[]
  • concat(...items: (T | ConcatArray<T>)[]): DatabaseOperation[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<DatabaseOperation>[]

      Additional items to add to the end of array1.

    Returns DatabaseOperation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DatabaseOperation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, DatabaseOperation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DatabaseOperation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: DatabaseOperation, index: number, array: DatabaseOperation[]): boolean
        • Parameters

          • value: DatabaseOperation
          • index: number
          • array: DatabaseOperation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: DatabaseOperation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DatabaseOperation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DatabaseOperation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: DatabaseOperation

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: DatabaseOperation, index: number, array: DatabaseOperation[]): boolean
        • Parameters

          • value: DatabaseOperation
          • index: number
          • array: DatabaseOperation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: DatabaseOperation, index: number, array: DatabaseOperation[]): any
        • Parameters

          • value: DatabaseOperation
          • index: number
          • array: DatabaseOperation[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DatabaseOperation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DatabaseOperation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: DatabaseOperation

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: DatabaseOperation, index: number, obj: DatabaseOperation[]): boolean
        • Parameters

          • this: void
          • value: DatabaseOperation
          • index: number
          • obj: DatabaseOperation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: DatabaseOperation, index: number, obj: DatabaseOperation[]): boolean
        • Parameters

          • value: DatabaseOperation
          • index: number
          • obj: DatabaseOperation[]

          Returns boolean

    • Optional thisArg: any

    Returns DatabaseOperation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: DatabaseOperation, index: number, obj: DatabaseOperation[]): boolean
        • Parameters

          • value: DatabaseOperation
          • index: number
          • obj: DatabaseOperation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: DatabaseOperation, index: number, array: DatabaseOperation[]): void
        • Parameters

          • value: DatabaseOperation
          • index: number
          • array: DatabaseOperation[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: DatabaseOperation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DatabaseOperation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: DatabaseOperation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DatabaseOperation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: DatabaseOperation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DatabaseOperation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: DatabaseOperation, index: number, array: DatabaseOperation[]): U
        • Parameters

          • value: DatabaseOperation
          • index: number
          • array: DatabaseOperation[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): DatabaseOperation | undefined
  • Removes the last element from an array and returns it.

    Returns DatabaseOperation | undefined

push

  • push(...items: DatabaseOperation[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: DatabaseOperation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): DatabaseOperation
  • reduce(callbackfn: function, initialValue: DatabaseOperation): DatabaseOperation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: DatabaseOperation, currentValue: DatabaseOperation, currentIndex: number, array: DatabaseOperation[]): DatabaseOperation
        • Parameters

          • previousValue: DatabaseOperation
          • currentValue: DatabaseOperation
          • currentIndex: number
          • array: DatabaseOperation[]

          Returns DatabaseOperation

    Returns DatabaseOperation

  • Parameters

    • callbackfn: function
        • (previousValue: DatabaseOperation, currentValue: DatabaseOperation, currentIndex: number, array: DatabaseOperation[]): DatabaseOperation
        • Parameters

          • previousValue: DatabaseOperation
          • currentValue: DatabaseOperation
          • currentIndex: number
          • array: DatabaseOperation[]

          Returns DatabaseOperation

    • initialValue: DatabaseOperation

    Returns DatabaseOperation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: DatabaseOperation, currentIndex: number, array: DatabaseOperation[]): U
        • Parameters

          • previousValue: U
          • currentValue: DatabaseOperation
          • currentIndex: number
          • array: DatabaseOperation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): DatabaseOperation
  • reduceRight(callbackfn: function, initialValue: DatabaseOperation): DatabaseOperation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: DatabaseOperation, currentValue: DatabaseOperation, currentIndex: number, array: DatabaseOperation[]): DatabaseOperation
        • Parameters

          • previousValue: DatabaseOperation
          • currentValue: DatabaseOperation
          • currentIndex: number
          • array: DatabaseOperation[]

          Returns DatabaseOperation

    Returns DatabaseOperation

  • Parameters

    • callbackfn: function
        • (previousValue: DatabaseOperation, currentValue: DatabaseOperation, currentIndex: number, array: DatabaseOperation[]): DatabaseOperation
        • Parameters

          • previousValue: DatabaseOperation
          • currentValue: DatabaseOperation
          • currentIndex: number
          • array: DatabaseOperation[]

          Returns DatabaseOperation

    • initialValue: DatabaseOperation

    Returns DatabaseOperation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: DatabaseOperation, currentIndex: number, array: DatabaseOperation[]): U
        • Parameters

          • previousValue: U
          • currentValue: DatabaseOperation
          • currentIndex: number
          • array: DatabaseOperation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): DatabaseOperation[]
  • Reverses the elements in an Array.

    Returns DatabaseOperation[]

shift

  • shift(): DatabaseOperation | undefined
  • Removes the first element from an array and returns it.

    Returns DatabaseOperation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): DatabaseOperation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DatabaseOperation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: DatabaseOperation, index: number, array: DatabaseOperation[]): boolean
        • Parameters

          • value: DatabaseOperation
          • index: number
          • array: DatabaseOperation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): DatabaseOperation[]
  • splice(start: number, deleteCount: number, ...items: DatabaseOperation[]): DatabaseOperation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DatabaseOperation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DatabaseOperation[]

      Elements to insert into the array in place of the deleted elements.

    Returns DatabaseOperation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: DatabaseOperation[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: DatabaseOperation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<DatabaseOperation>
  • Returns an iterable of values in the array

    Returns IterableIterator<DatabaseOperation>

type

type: object

className

className: string = "DatabaseOperationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DatabaseOperation"

name

name: "Composite" = "Composite"

Const DatabaseSecurityAlertPolicy

DatabaseSecurityAlertPolicy: object

Contains information about a database Threat Detection policy.

Optional disabledAlerts

disabledAlerts: undefined | string

Specifies the semicolon-separated list of alerts that are disabled, or empty string to disable no alerts. Possible values: Sql_Injection; Sql_Injection_Vulnerability; Access_Anomaly; Data_Exfiltration; Unsafe_Action.

Optional emailAccountAdmins

Specifies that the alert is sent to the account administrators. Possible values include: 'Enabled', 'Disabled'

Optional emailAddresses

emailAddresses: undefined | string

Specifies the semicolon-separated list of e-mail addresses to which the alert is sent.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Resource kind. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The geo-location where the resource lives

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional retentionDays

retentionDays: undefined | number

Specifies the number of days to keep in the Threat Detection audit logs.

serializedName

serializedName: string = "DatabaseSecurityAlertPolicy"

state

Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required. Possible values include: 'New', 'Enabled', 'Disabled'

Optional storageAccountAccessKey

storageAccountAccessKey: undefined | string

Specifies the identifier key of the Threat Detection audit storage account. If state is Enabled, storageAccountAccessKey is required.

Optional storageEndpoint

storageEndpoint: undefined | string

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. If state is Enabled, storageEndpoint is required.

Optional useServerDefault

Specifies whether to use the default server policy. Possible values include: 'Enabled', 'Disabled'

type

type: object

className

className: string = "DatabaseSecurityAlertPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

disabledAlerts

disabledAlerts: object

serializedName

serializedName: string = "properties.disabledAlerts"

type

type: object

name

name: "String" = "String"

emailAccountAdmins

emailAccountAdmins: object

serializedName

serializedName: string = "properties.emailAccountAdmins"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

emailAddresses

emailAddresses: object

serializedName

serializedName: string = "properties.emailAddresses"

type

type: object

name

name: "String" = "String"

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

retentionDays

retentionDays: object

serializedName

serializedName: string = "properties.retentionDays"

type

type: object

name

name: "Number" = "Number"

state

state: object

required

required: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["New","Enabled","Disabled"]

name

name: "Enum" = "Enum"

storageAccountAccessKey

storageAccountAccessKey: object

serializedName

serializedName: string = "properties.storageAccountAccessKey"

type

type: object

name

name: "String" = "String"

storageEndpoint

storageEndpoint: object

serializedName

serializedName: string = "properties.storageEndpoint"

type

type: object

name

name: "String" = "String"

useServerDefault

useServerDefault: object

serializedName

serializedName: string = "properties.useServerDefault"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

Const DatabaseUpdate

DatabaseUpdate: object

A database resource.

Optional catalogCollation

catalogCollation: CatalogCollationType

Collation of the metadata catalog. Possible values include: 'DATABASE_DEFAULT', 'SQL_Latin1_General_CP1_CI_AS'

Optional collation

collation: undefined | string

The collation of the database.

Optional createMode

createMode: CreateMode

Specifies the mode of database creation.

Default: regular database creation.

Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.

Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.

PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.

Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.

Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.

RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.

Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. Possible values include: 'Default', 'Copy', 'Secondary', 'PointInTimeRestore', 'Restore', 'Recovery', 'RestoreExternalBackup', 'RestoreExternalBackupSecondary', 'RestoreLongTermRetentionBackup', 'OnlineSecondary'

Optional creationDate

creationDate: Date

The creation date of the database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional currentServiceObjectiveName

currentServiceObjectiveName: undefined | string

The current service level objective name of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional currentSku

currentSku: Sku

The name and tier of the SKU. NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseId

databaseId: undefined | string

The ID of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultSecondaryLocation

defaultSecondaryLocation: undefined | string

The default secondary region for this database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional earliestRestoreDate

earliestRestoreDate: Date

This records the earliest start date and time that restore is available for this database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional elasticPoolId

elasticPoolId: undefined | string

The resource identifier of the elastic pool containing this database.

Optional failoverGroupId

failoverGroupId: undefined | string

Failover Group resource identifier that this database belongs to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional licenseType

licenseType: DatabaseLicenseType

The license type to apply for this database. Possible values include: 'LicenseIncluded', 'BasePrice'

Optional longTermRetentionBackupResourceId

longTermRetentionBackupResourceId: undefined | string

The resource identifier of the long term retention backup associated with create operation of this database.

Optional maxLogSizeBytes

maxLogSizeBytes: undefined | number

The max log size for this database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxSizeBytes

maxSizeBytes: undefined | number

The max size of the database expressed in bytes.

Optional readScale

The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Possible values include: 'Enabled', 'Disabled'

Optional recoverableDatabaseId

recoverableDatabaseId: undefined | string

The resource identifier of the recoverable database associated with create operation of this database.

Optional recoveryServicesRecoveryPointId

recoveryServicesRecoveryPointId: undefined | string

The resource identifier of the recovery point associated with create operation of this database.

Optional requestedServiceObjectiveName

requestedServiceObjectiveName: undefined | string

The requested service level objective name of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional restorableDroppedDatabaseId

restorableDroppedDatabaseId: undefined | string

The resource identifier of the restorable dropped database associated with create operation of this database.

Optional restorePointInTime

restorePointInTime: Date

Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

Optional sampleName

sampleName: SampleName

The name of the sample schema to apply when creating this database. Possible values include: 'AdventureWorksLT', 'WideWorldImportersStd', 'WideWorldImportersFull'

serializedName

serializedName: string = "DatabaseUpdate"

Optional sku

sku: Sku

The name and tier of the SKU.

Optional sourceDatabaseDeletionDate

sourceDatabaseDeletionDate: Date

Specifies the time that the database was deleted.

Optional sourceDatabaseId

sourceDatabaseId: undefined | string

The resource identifier of the source database associated with create operation of this database.

Optional status

The status of the database. Possible values include: 'Online', 'Restoring', 'RecoveryPending', 'Recovering', 'Suspect', 'Offline', 'Standby', 'Shutdown', 'EmergencyMode', 'AutoClosed', 'Copying', 'Creating', 'Inaccessible', 'OfflineSecondary', 'Pausing', 'Paused', 'Resuming', 'Scaling' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

Optional zoneRedundant

zoneRedundant: undefined | false | true

Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

type

type: object

className

className: string = "DatabaseUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

catalogCollation

catalogCollation: object

serializedName

serializedName: string = "properties.catalogCollation"

type

type: object

name

name: "String" = "String"

collation

collation: object

serializedName

serializedName: string = "properties.collation"

type

type: object

name

name: "String" = "String"

createMode

createMode: object

serializedName

serializedName: string = "properties.createMode"

type

type: object

name

name: "String" = "String"

creationDate

creationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationDate"

type

type: object

name

name: "DateTime" = "DateTime"

currentServiceObjectiveName

currentServiceObjectiveName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.currentServiceObjectiveName"

type

type: object

name

name: "String" = "String"

currentSku

currentSku: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.currentSku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

databaseId

databaseId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseId"

type

type: object

name

name: "Uuid" = "Uuid"

defaultSecondaryLocation

defaultSecondaryLocation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultSecondaryLocation"

type

type: object

name

name: "String" = "String"

earliestRestoreDate

earliestRestoreDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.earliestRestoreDate"

type

type: object

name

name: "DateTime" = "DateTime"

elasticPoolId

elasticPoolId: object

serializedName

serializedName: string = "properties.elasticPoolId"

type

type: object

name

name: "String" = "String"

failoverGroupId

failoverGroupId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.failoverGroupId"

type

type: object

name

name: "String" = "String"

licenseType

licenseType: object

serializedName

serializedName: string = "properties.licenseType"

type

type: object

name

name: "String" = "String"

longTermRetentionBackupResourceId

longTermRetentionBackupResourceId: object

serializedName

serializedName: string = "properties.longTermRetentionBackupResourceId"

type

type: object

name

name: "String" = "String"

maxLogSizeBytes

maxLogSizeBytes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maxLogSizeBytes"

type

type: object

name

name: "Number" = "Number"

maxSizeBytes

maxSizeBytes: object

serializedName

serializedName: string = "properties.maxSizeBytes"

type

type: object

name

name: "Number" = "Number"

readScale

readScale: object

serializedName

serializedName: string = "properties.readScale"

type

type: object

name

name: "String" = "String"

recoverableDatabaseId

recoverableDatabaseId: object

serializedName

serializedName: string = "properties.recoverableDatabaseId"

type

type: object

name

name: "String" = "String"

recoveryServicesRecoveryPointId

recoveryServicesRecoveryPointId: object

serializedName

serializedName: string = "properties.recoveryServicesRecoveryPointId"

type

type: object

name

name: "String" = "String"

requestedServiceObjectiveName

requestedServiceObjectiveName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedServiceObjectiveName"

type

type: object

name

name: "String" = "String"

restorableDroppedDatabaseId

restorableDroppedDatabaseId: object

serializedName

serializedName: string = "properties.restorableDroppedDatabaseId"

type

type: object

name

name: "String" = "String"

restorePointInTime

restorePointInTime: object

serializedName

serializedName: string = "properties.restorePointInTime"

type

type: object

name

name: "DateTime" = "DateTime"

sampleName

sampleName: object

serializedName

serializedName: string = "properties.sampleName"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

sourceDatabaseDeletionDate

sourceDatabaseDeletionDate: object

serializedName

serializedName: string = "properties.sourceDatabaseDeletionDate"

type

type: object

name

name: "DateTime" = "DateTime"

sourceDatabaseId

sourceDatabaseId: object

serializedName

serializedName: string = "properties.sourceDatabaseId"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

zoneRedundant

zoneRedundant: object

serializedName

serializedName: string = "properties.zoneRedundant"

type

type: object

name

name: "Boolean" = "Boolean"

Const DatabaseUsage

DatabaseUsage: object

The database usages.

Optional currentValue

currentValue: undefined | number

The current value of the usage metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional displayName

displayName: undefined | string

The usage metric display name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional limit

limit: undefined | number

The current limit of the usage metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the usage metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextResetTime

nextResetTime: Date

The next reset time for the usage metric (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceName

resourceName: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DatabaseUsage"

Optional unit

unit: undefined | string

The units of the usage metric. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "DatabaseUsage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentValue

currentValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "currentValue"

type

type: object

name

name: "Number" = "Number"

displayName

displayName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

limit

limit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "limit"

type

type: object

name

name: "Number" = "Number"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

nextResetTime

nextResetTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextResetTime"

type

type: object

name

name: "DateTime" = "DateTime"

resourceName

resourceName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resourceName"

type

type: object

name

name: "String" = "String"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const DatabaseUsageListResult

DatabaseUsageListResult: object
interface

The response to a list database metrics request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "DatabaseUsageListResult"

__@iterator

  • __@iterator(): IterableIterator<DatabaseUsage>
  • Iterator

    Returns IterableIterator<DatabaseUsage>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<DatabaseUsage>[]): DatabaseUsage[]
  • concat(...items: (T | ConcatArray<T>)[]): DatabaseUsage[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<DatabaseUsage>[]

      Additional items to add to the end of array1.

    Returns DatabaseUsage[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DatabaseUsage[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, DatabaseUsage]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DatabaseUsage]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: DatabaseUsage, index: number, array: DatabaseUsage[]): boolean
        • Parameters

          • value: DatabaseUsage
          • index: number
          • array: DatabaseUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: DatabaseUsage, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DatabaseUsage

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DatabaseUsage[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: DatabaseUsage

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: DatabaseUsage, index: number, array: DatabaseUsage[]): boolean
        • Parameters

          • value: DatabaseUsage
          • index: number
          • array: DatabaseUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: DatabaseUsage, index: number, array: DatabaseUsage[]): any
        • Parameters

          • value: DatabaseUsage
          • index: number
          • array: DatabaseUsage[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DatabaseUsage[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DatabaseUsage | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: DatabaseUsage

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: DatabaseUsage, index: number, obj: DatabaseUsage[]): boolean
        • Parameters

          • this: void
          • value: DatabaseUsage
          • index: number
          • obj: DatabaseUsage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: DatabaseUsage, index: number, obj: DatabaseUsage[]): boolean
        • Parameters

          • value: DatabaseUsage
          • index: number
          • obj: DatabaseUsage[]

          Returns boolean

    • Optional thisArg: any

    Returns DatabaseUsage | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: DatabaseUsage, index: number, obj: DatabaseUsage[]): boolean
        • Parameters

          • value: DatabaseUsage
          • index: number
          • obj: DatabaseUsage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: DatabaseUsage, index: number, array: DatabaseUsage[]): void
        • Parameters

          • value: DatabaseUsage
          • index: number
          • array: DatabaseUsage[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: DatabaseUsage, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DatabaseUsage

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: DatabaseUsage, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DatabaseUsage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: DatabaseUsage, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DatabaseUsage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: DatabaseUsage, index: number, array: DatabaseUsage[]): U
        • Parameters

          • value: DatabaseUsage
          • index: number
          • array: DatabaseUsage[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): DatabaseUsage | undefined
  • Removes the last element from an array and returns it.

    Returns DatabaseUsage | undefined

push

  • push(...items: DatabaseUsage[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: DatabaseUsage[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): DatabaseUsage
  • reduce(callbackfn: function, initialValue: DatabaseUsage): DatabaseUsage
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: DatabaseUsage, currentValue: DatabaseUsage, currentIndex: number, array: DatabaseUsage[]): DatabaseUsage
        • Parameters

          • previousValue: DatabaseUsage
          • currentValue: DatabaseUsage
          • currentIndex: number
          • array: DatabaseUsage[]

          Returns DatabaseUsage

    Returns DatabaseUsage

  • Parameters

    • callbackfn: function
        • (previousValue: DatabaseUsage, currentValue: DatabaseUsage, currentIndex: number, array: DatabaseUsage[]): DatabaseUsage
        • Parameters

          • previousValue: DatabaseUsage
          • currentValue: DatabaseUsage
          • currentIndex: number
          • array: DatabaseUsage[]

          Returns DatabaseUsage

    • initialValue: DatabaseUsage

    Returns DatabaseUsage

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: DatabaseUsage, currentIndex: number, array: DatabaseUsage[]): U
        • Parameters

          • previousValue: U
          • currentValue: DatabaseUsage
          • currentIndex: number
          • array: DatabaseUsage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): DatabaseUsage
  • reduceRight(callbackfn: function, initialValue: DatabaseUsage): DatabaseUsage
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: DatabaseUsage, currentValue: DatabaseUsage, currentIndex: number, array: DatabaseUsage[]): DatabaseUsage
        • Parameters

          • previousValue: DatabaseUsage
          • currentValue: DatabaseUsage
          • currentIndex: number
          • array: DatabaseUsage[]

          Returns DatabaseUsage

    Returns DatabaseUsage

  • Parameters

    • callbackfn: function
        • (previousValue: DatabaseUsage, currentValue: DatabaseUsage, currentIndex: number, array: DatabaseUsage[]): DatabaseUsage
        • Parameters

          • previousValue: DatabaseUsage
          • currentValue: DatabaseUsage
          • currentIndex: number
          • array: DatabaseUsage[]

          Returns DatabaseUsage

    • initialValue: DatabaseUsage

    Returns DatabaseUsage

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: DatabaseUsage, currentIndex: number, array: DatabaseUsage[]): U
        • Parameters

          • previousValue: U
          • currentValue: DatabaseUsage
          • currentIndex: number
          • array: DatabaseUsage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): DatabaseUsage[]
  • Reverses the elements in an Array.

    Returns DatabaseUsage[]

shift

  • shift(): DatabaseUsage | undefined
  • Removes the first element from an array and returns it.

    Returns DatabaseUsage | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): DatabaseUsage[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DatabaseUsage[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: DatabaseUsage, index: number, array: DatabaseUsage[]): boolean
        • Parameters

          • value: DatabaseUsage
          • index: number
          • array: DatabaseUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): DatabaseUsage[]
  • splice(start: number, deleteCount: number, ...items: DatabaseUsage[]): DatabaseUsage[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DatabaseUsage[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DatabaseUsage[]

      Elements to insert into the array in place of the deleted elements.

    Returns DatabaseUsage[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: DatabaseUsage[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: DatabaseUsage[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<DatabaseUsage>
  • Returns an iterable of values in the array

    Returns IterableIterator<DatabaseUsage>

type

type: object

className

className: string = "DatabaseUsageListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DatabaseUsage"

name

name: "Composite" = "Composite"

Const DatabaseVulnerabilityAssessment

DatabaseVulnerabilityAssessment: object

A database vulnerability assessment.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional recurringScans

The recurring scans settings

serializedName

serializedName: string = "DatabaseVulnerabilityAssessment"

Optional storageAccountAccessKey

storageAccountAccessKey: undefined | string

Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.

Optional storageContainerPath

storageContainerPath: undefined | string

A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set

Optional storageContainerSasKey

storageContainerSasKey: undefined | string

A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.

type

type: object

className

className: string = "DatabaseVulnerabilityAssessment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

recurringScans

recurringScans: object

serializedName

serializedName: string = "properties.recurringScans"

type

type: object

className

className: string = "VulnerabilityAssessmentRecurringScansProperties"

name

name: "Composite" = "Composite"

storageAccountAccessKey

storageAccountAccessKey: object

serializedName

serializedName: string = "properties.storageAccountAccessKey"

type

type: object

name

name: "String" = "String"

storageContainerPath

storageContainerPath: object

serializedName

serializedName: string = "properties.storageContainerPath"

type

type: object

name

name: "String" = "String"

storageContainerSasKey

storageContainerSasKey: object

serializedName

serializedName: string = "properties.storageContainerSasKey"

type

type: object

name

name: "String" = "String"

Const DatabaseVulnerabilityAssessmentListResult

DatabaseVulnerabilityAssessmentListResult: object
interface

A list of the database's vulnerability assessments.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DatabaseVulnerabilityAssessmentListResult"

__@iterator

  • __@iterator(): IterableIterator<DatabaseVulnerabilityAssessment>
  • Iterator

    Returns IterableIterator<DatabaseVulnerabilityAssessment>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<DatabaseVulnerabilityAssessment>[]): DatabaseVulnerabilityAssessment[]
  • concat(...items: (T | ConcatArray<T>)[]): DatabaseVulnerabilityAssessment[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<DatabaseVulnerabilityAssessment>[]

      Additional items to add to the end of array1.

    Returns DatabaseVulnerabilityAssessment[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DatabaseVulnerabilityAssessment[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, DatabaseVulnerabilityAssessment]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DatabaseVulnerabilityAssessment]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: DatabaseVulnerabilityAssessment, index: number, array: DatabaseVulnerabilityAssessment[]): boolean
        • Parameters

          • value: DatabaseVulnerabilityAssessment
          • index: number
          • array: DatabaseVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: DatabaseVulnerabilityAssessment, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DatabaseVulnerabilityAssessment

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DatabaseVulnerabilityAssessment[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: DatabaseVulnerabilityAssessment

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: DatabaseVulnerabilityAssessment, index: number, array: DatabaseVulnerabilityAssessment[]): boolean
        • Parameters

          • value: DatabaseVulnerabilityAssessment
          • index: number
          • array: DatabaseVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: DatabaseVulnerabilityAssessment, index: number, array: DatabaseVulnerabilityAssessment[]): any
        • Parameters

          • value: DatabaseVulnerabilityAssessment
          • index: number
          • array: DatabaseVulnerabilityAssessment[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DatabaseVulnerabilityAssessment[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DatabaseVulnerabilityAssessment | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: DatabaseVulnerabilityAssessment

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: DatabaseVulnerabilityAssessment, index: number, obj: DatabaseVulnerabilityAssessment[]): boolean
        • Parameters

          • this: void
          • value: DatabaseVulnerabilityAssessment
          • index: number
          • obj: DatabaseVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: DatabaseVulnerabilityAssessment, index: number, obj: DatabaseVulnerabilityAssessment[]): boolean
        • Parameters

          • value: DatabaseVulnerabilityAssessment
          • index: number
          • obj: DatabaseVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

    Returns DatabaseVulnerabilityAssessment | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: DatabaseVulnerabilityAssessment, index: number, obj: DatabaseVulnerabilityAssessment[]): boolean
        • Parameters

          • value: DatabaseVulnerabilityAssessment
          • index: number
          • obj: DatabaseVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: DatabaseVulnerabilityAssessment, index: number, array: DatabaseVulnerabilityAssessment[]): void
        • Parameters

          • value: DatabaseVulnerabilityAssessment
          • index: number
          • array: DatabaseVulnerabilityAssessment[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: DatabaseVulnerabilityAssessment, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DatabaseVulnerabilityAssessment

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: DatabaseVulnerabilityAssessment, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DatabaseVulnerabilityAssessment

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: DatabaseVulnerabilityAssessment, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DatabaseVulnerabilityAssessment

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: DatabaseVulnerabilityAssessment, index: number, array: DatabaseVulnerabilityAssessment[]): U
        • Parameters

          • value: DatabaseVulnerabilityAssessment
          • index: number
          • array: DatabaseVulnerabilityAssessment[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): DatabaseVulnerabilityAssessment | undefined
  • Removes the last element from an array and returns it.

    Returns DatabaseVulnerabilityAssessment | undefined

push

  • push(...items: DatabaseVulnerabilityAssessment[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: DatabaseVulnerabilityAssessment[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): DatabaseVulnerabilityAssessment
  • reduce(callbackfn: function, initialValue: DatabaseVulnerabilityAssessment): DatabaseVulnerabilityAssessment
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: DatabaseVulnerabilityAssessment, currentValue: DatabaseVulnerabilityAssessment, currentIndex: number, array: DatabaseVulnerabilityAssessment[]): DatabaseVulnerabilityAssessment
        • Parameters

          • previousValue: DatabaseVulnerabilityAssessment
          • currentValue: DatabaseVulnerabilityAssessment
          • currentIndex: number
          • array: DatabaseVulnerabilityAssessment[]

          Returns DatabaseVulnerabilityAssessment

    Returns DatabaseVulnerabilityAssessment

  • Parameters

    • callbackfn: function
        • (previousValue: DatabaseVulnerabilityAssessment, currentValue: DatabaseVulnerabilityAssessment, currentIndex: number, array: DatabaseVulnerabilityAssessment[]): DatabaseVulnerabilityAssessment
        • Parameters

          • previousValue: DatabaseVulnerabilityAssessment
          • currentValue: DatabaseVulnerabilityAssessment
          • currentIndex: number
          • array: DatabaseVulnerabilityAssessment[]

          Returns DatabaseVulnerabilityAssessment

    • initialValue: DatabaseVulnerabilityAssessment

    Returns DatabaseVulnerabilityAssessment

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: DatabaseVulnerabilityAssessment, currentIndex: number, array: DatabaseVulnerabilityAssessment[]): U
        • Parameters

          • previousValue: U
          • currentValue: DatabaseVulnerabilityAssessment
          • currentIndex: number
          • array: DatabaseVulnerabilityAssessment[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): DatabaseVulnerabilityAssessment
  • reduceRight(callbackfn: function, initialValue: DatabaseVulnerabilityAssessment): DatabaseVulnerabilityAssessment
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: DatabaseVulnerabilityAssessment, currentValue: DatabaseVulnerabilityAssessment, currentIndex: number, array: DatabaseVulnerabilityAssessment[]): DatabaseVulnerabilityAssessment
        • Parameters

          • previousValue: DatabaseVulnerabilityAssessment
          • currentValue: DatabaseVulnerabilityAssessment
          • currentIndex: number
          • array: DatabaseVulnerabilityAssessment[]

          Returns DatabaseVulnerabilityAssessment

    Returns DatabaseVulnerabilityAssessment

  • Parameters

    • callbackfn: function
        • (previousValue: DatabaseVulnerabilityAssessment, currentValue: DatabaseVulnerabilityAssessment, currentIndex: number, array: DatabaseVulnerabilityAssessment[]): DatabaseVulnerabilityAssessment
        • Parameters

          • previousValue: DatabaseVulnerabilityAssessment
          • currentValue: DatabaseVulnerabilityAssessment
          • currentIndex: number
          • array: DatabaseVulnerabilityAssessment[]

          Returns DatabaseVulnerabilityAssessment

    • initialValue: DatabaseVulnerabilityAssessment

    Returns DatabaseVulnerabilityAssessment

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: DatabaseVulnerabilityAssessment, currentIndex: number, array: DatabaseVulnerabilityAssessment[]): U
        • Parameters

          • previousValue: U
          • currentValue: DatabaseVulnerabilityAssessment
          • currentIndex: number
          • array: DatabaseVulnerabilityAssessment[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): DatabaseVulnerabilityAssessment[]
  • Reverses the elements in an Array.

    Returns DatabaseVulnerabilityAssessment[]

shift

  • shift(): DatabaseVulnerabilityAssessment | undefined
  • Removes the first element from an array and returns it.

    Returns DatabaseVulnerabilityAssessment | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): DatabaseVulnerabilityAssessment[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DatabaseVulnerabilityAssessment[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: DatabaseVulnerabilityAssessment, index: number, array: DatabaseVulnerabilityAssessment[]): boolean
        • Parameters

          • value: DatabaseVulnerabilityAssessment
          • index: number
          • array: DatabaseVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): DatabaseVulnerabilityAssessment[]
  • splice(start: number, deleteCount: number, ...items: DatabaseVulnerabilityAssessment[]): DatabaseVulnerabilityAssessment[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DatabaseVulnerabilityAssessment[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DatabaseVulnerabilityAssessment[]

      Elements to insert into the array in place of the deleted elements.

    Returns DatabaseVulnerabilityAssessment[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: DatabaseVulnerabilityAssessment[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: DatabaseVulnerabilityAssessment[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<DatabaseVulnerabilityAssessment>
  • Returns an iterable of values in the array

    Returns IterableIterator<DatabaseVulnerabilityAssessment>

type

type: object

className

className: string = "DatabaseVulnerabilityAssessmentListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DatabaseVulnerabilityAssessment"

name

name: "Composite" = "Composite"

Const DatabaseVulnerabilityAssessmentRuleBaseline

DatabaseVulnerabilityAssessmentRuleBaseline: object

A database vulnerability assessment rule baseline.

baselineResults

baselineResults: DatabaseVulnerabilityAssessmentRuleBaselineItem[]

The rule baseline result

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DatabaseVulnerabilityAssessmentRuleBaseline"

type

type: object

className

className: string = "DatabaseVulnerabilityAssessmentRuleBaseline"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

baselineResults

baselineResults: object

required

required: true = true

serializedName

serializedName: string = "properties.baselineResults"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DatabaseVulnerabilityAssessmentRuleBaselineItem"

name

name: "Composite" = "Composite"

Const DatabaseVulnerabilityAssessmentRuleBaselineItem

DatabaseVulnerabilityAssessmentRuleBaselineItem: object

Properties for an Azure SQL Database Vulnerability Assessment rule baseline's result.

result

result: string[]

The rule baseline result

serializedName

serializedName: string = "DatabaseVulnerabilityAssessmentRuleBaselineItem"

type

type: object

className

className: string = "DatabaseVulnerabilityAssessmentRuleBaselineItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

result

result: object

required

required: true = true

serializedName

serializedName: string = "result"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const DatabaseVulnerabilityAssessmentScansExport

DatabaseVulnerabilityAssessmentScansExport: object

A database Vulnerability Assessment scan export resource.

Optional exportedReportLocation

exportedReportLocation: undefined | string

Location of the exported report (e.g. https://myStorage.blob.core.windows.net/VaScans/scans/serverName/databaseName/scan_scanId.xlsx). NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DatabaseVulnerabilityAssessmentScansExport"

type

type: object

className

className: string = "DatabaseVulnerabilityAssessmentScansExport"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

exportedReportLocation

exportedReportLocation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.exportedReportLocation"

type

type: object

name

name: "String" = "String"

Const EditionCapability

EditionCapability: object

The edition capability.

Optional name

name: undefined | string

The database edition name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "EditionCapability"

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedServiceLevelObjectives

supportedServiceLevelObjectives: ServiceObjectiveCapability[]

The list of supported service objectives for the edition. NOTE: This property will not be serialized. It can only be populated by the server.

Optional zoneRedundant

zoneRedundant: undefined | false | true

Whether or not zone redundancy is supported for the edition. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "EditionCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

supportedServiceLevelObjectives

supportedServiceLevelObjectives: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedServiceLevelObjectives"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceObjectiveCapability"

name

name: "Composite" = "Composite"

zoneRedundant

zoneRedundant: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "zoneRedundant"

type

type: object

name

name: "Boolean" = "Boolean"

Const ElasticPool

ElasticPool: object

An elastic pool.

Optional creationDate

creationDate: Date

The creation date of the elastic pool (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of elastic pool. This is metadata used for the Azure portal experience. NOTE: This property will not be serialized. It can only be populated by the server.

Optional licenseType

The license type to apply for this elastic pool. Possible values include: 'LicenseIncluded', 'BasePrice'

location

location: string

Resource location.

Optional maxSizeBytes

maxSizeBytes: undefined | number

The storage limit for the database elastic pool in bytes.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional perDatabaseSettings

perDatabaseSettings: ElasticPoolPerDatabaseSettings

The per database settings for the elastic pool.

serializedName

serializedName: string = "ElasticPool"

Optional sku

sku: Sku

Optional state

The state of the elastic pool. Possible values include: 'Creating', 'Ready', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

Optional zoneRedundant

zoneRedundant: undefined | false | true

Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

type

type: object

className

className: string = "ElasticPool"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationDate

creationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationDate"

type

type: object

name

name: "DateTime" = "DateTime"

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

licenseType

licenseType: object

serializedName

serializedName: string = "properties.licenseType"

type

type: object

name

name: "String" = "String"

maxSizeBytes

maxSizeBytes: object

serializedName

serializedName: string = "properties.maxSizeBytes"

type

type: object

name

name: "Number" = "Number"

perDatabaseSettings

perDatabaseSettings: object

serializedName

serializedName: string = "properties.perDatabaseSettings"

type

type: object

className

className: string = "ElasticPoolPerDatabaseSettings"

name

name: "Composite" = "Composite"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

zoneRedundant

zoneRedundant: object

serializedName

serializedName: string = "properties.zoneRedundant"

type

type: object

name

name: "Boolean" = "Boolean"

Const ElasticPoolActivity

ElasticPoolActivity: object

Represents the activity on an elastic pool.

Optional elasticPoolName

elasticPoolName: undefined | string

The name of the elastic pool. NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date

The time the operation finished (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorCode

errorCode: undefined | number

The error code if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorMessage

errorMessage: undefined | string

The error message if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorSeverity

errorSeverity: undefined | number

The error severity if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The geo-location where the resource lives

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operation

operation: undefined | string

The operation name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationId

operationId: undefined | string

The unique operation ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional percentComplete

percentComplete: undefined | number

The percentage complete if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestedDatabaseDtuCap

requestedDatabaseDtuCap: undefined | number

The requested per database DTU cap. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestedDatabaseDtuGuarantee

requestedDatabaseDtuGuarantee: undefined | number

The requested per database DTU guarantee. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestedDatabaseDtuMax

requestedDatabaseDtuMax: undefined | number

The requested max DTU per database if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestedDatabaseDtuMin

requestedDatabaseDtuMin: undefined | number

The requested min DTU per database if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestedDtu

requestedDtu: undefined | number

The requested DTU for the pool if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestedDtuGuarantee

requestedDtuGuarantee: undefined | number

The requested DTU guarantee. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestedElasticPoolName

requestedElasticPoolName: undefined | string

The requested name for the elastic pool if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestedStorageLimitInGB

requestedStorageLimitInGB: undefined | number

The requested storage limit for the pool in GB if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestedStorageLimitInMB

requestedStorageLimitInMB: undefined | number

The requested storage limit in MB. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ElasticPoolActivity"

Optional serverName

serverName: undefined | string

The name of the server the elastic pool is in. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date

The time the operation started (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

state: undefined | string

The current state of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ElasticPoolActivity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

elasticPoolName

elasticPoolName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.elasticPoolName"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

errorCode

errorCode: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorCode"

type

type: object

name

name: "Number" = "Number"

errorMessage

errorMessage: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorMessage"

type

type: object

name

name: "String" = "String"

errorSeverity

errorSeverity: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorSeverity"

type

type: object

name

name: "Number" = "Number"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

operation

operation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operation"

type

type: object

name

name: "String" = "String"

operationId

operationId: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operationId"

type

type: object

name

name: "Uuid" = "Uuid"

percentComplete

percentComplete: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.percentComplete"

type

type: object

name

name: "Number" = "Number"

requestedDatabaseDtuCap

requestedDatabaseDtuCap: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedDatabaseDtuCap"

type

type: object

name

name: "Number" = "Number"

requestedDatabaseDtuGuarantee

requestedDatabaseDtuGuarantee: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedDatabaseDtuGuarantee"

type

type: object

name

name: "Number" = "Number"

requestedDatabaseDtuMax

requestedDatabaseDtuMax: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedDatabaseDtuMax"

type

type: object

name

name: "Number" = "Number"

requestedDatabaseDtuMin

requestedDatabaseDtuMin: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedDatabaseDtuMin"

type

type: object

name

name: "Number" = "Number"

requestedDtu

requestedDtu: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedDtu"

type

type: object

name

name: "Number" = "Number"

requestedDtuGuarantee

requestedDtuGuarantee: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedDtuGuarantee"

type

type: object

name

name: "Number" = "Number"

requestedElasticPoolName

requestedElasticPoolName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedElasticPoolName"

type

type: object

name

name: "String" = "String"

requestedStorageLimitInGB

requestedStorageLimitInGB: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedStorageLimitInGB"

type

type: object

name

name: "Number" = "Number"

requestedStorageLimitInMB

requestedStorageLimitInMB: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedStorageLimitInMB"

type

type: object

name

name: "Number" = "Number"

serverName

serverName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serverName"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const ElasticPoolActivityListResult

ElasticPoolActivityListResult: object
interface

Represents the response to a list elastic pool activity request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ElasticPoolActivityListResult"

__@iterator

  • __@iterator(): IterableIterator<ElasticPoolActivity>
  • Iterator

    Returns IterableIterator<ElasticPoolActivity>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ElasticPoolActivity>[]): ElasticPoolActivity[]
  • concat(...items: (T | ConcatArray<T>)[]): ElasticPoolActivity[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ElasticPoolActivity>[]

      Additional items to add to the end of array1.

    Returns ElasticPoolActivity[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ElasticPoolActivity[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ElasticPoolActivity]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ElasticPoolActivity]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ElasticPoolActivity, index: number, array: ElasticPoolActivity[]): boolean
        • Parameters

          • value: ElasticPoolActivity
          • index: number
          • array: ElasticPoolActivity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ElasticPoolActivity, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ElasticPoolActivity

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ElasticPoolActivity[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ElasticPoolActivity

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ElasticPoolActivity, index: number, array: ElasticPoolActivity[]): boolean
        • Parameters

          • value: ElasticPoolActivity
          • index: number
          • array: ElasticPoolActivity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ElasticPoolActivity, index: number, array: ElasticPoolActivity[]): any
        • Parameters

          • value: ElasticPoolActivity
          • index: number
          • array: ElasticPoolActivity[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ElasticPoolActivity[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ElasticPoolActivity | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ElasticPoolActivity

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ElasticPoolActivity, index: number, obj: ElasticPoolActivity[]): boolean
        • Parameters

          • this: void
          • value: ElasticPoolActivity
          • index: number
          • obj: ElasticPoolActivity[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ElasticPoolActivity, index: number, obj: ElasticPoolActivity[]): boolean
        • Parameters

          • value: ElasticPoolActivity
          • index: number
          • obj: ElasticPoolActivity[]

          Returns boolean

    • Optional thisArg: any

    Returns ElasticPoolActivity | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ElasticPoolActivity, index: number, obj: ElasticPoolActivity[]): boolean
        • Parameters

          • value: ElasticPoolActivity
          • index: number
          • obj: ElasticPoolActivity[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ElasticPoolActivity, index: number, array: ElasticPoolActivity[]): void
        • Parameters

          • value: ElasticPoolActivity
          • index: number
          • array: ElasticPoolActivity[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ElasticPoolActivity, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ElasticPoolActivity

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ElasticPoolActivity, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ElasticPoolActivity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ElasticPoolActivity, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ElasticPoolActivity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ElasticPoolActivity, index: number, array: ElasticPoolActivity[]): U
        • Parameters

          • value: ElasticPoolActivity
          • index: number
          • array: ElasticPoolActivity[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ElasticPoolActivity | undefined
  • Removes the last element from an array and returns it.

    Returns ElasticPoolActivity | undefined

push

  • push(...items: ElasticPoolActivity[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ElasticPoolActivity[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ElasticPoolActivity
  • reduce(callbackfn: function, initialValue: ElasticPoolActivity): ElasticPoolActivity
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ElasticPoolActivity, currentValue: ElasticPoolActivity, currentIndex: number, array: ElasticPoolActivity[]): ElasticPoolActivity
        • Parameters

          • previousValue: ElasticPoolActivity
          • currentValue: ElasticPoolActivity
          • currentIndex: number
          • array: ElasticPoolActivity[]

          Returns ElasticPoolActivity

    Returns ElasticPoolActivity

  • Parameters

    • callbackfn: function
        • (previousValue: ElasticPoolActivity, currentValue: ElasticPoolActivity, currentIndex: number, array: ElasticPoolActivity[]): ElasticPoolActivity
        • Parameters

          • previousValue: ElasticPoolActivity
          • currentValue: ElasticPoolActivity
          • currentIndex: number
          • array: ElasticPoolActivity[]

          Returns ElasticPoolActivity

    • initialValue: ElasticPoolActivity

    Returns ElasticPoolActivity

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ElasticPoolActivity, currentIndex: number, array: ElasticPoolActivity[]): U
        • Parameters

          • previousValue: U
          • currentValue: ElasticPoolActivity
          • currentIndex: number
          • array: ElasticPoolActivity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ElasticPoolActivity
  • reduceRight(callbackfn: function, initialValue: ElasticPoolActivity): ElasticPoolActivity
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ElasticPoolActivity, currentValue: ElasticPoolActivity, currentIndex: number, array: ElasticPoolActivity[]): ElasticPoolActivity
        • Parameters

          • previousValue: ElasticPoolActivity
          • currentValue: ElasticPoolActivity
          • currentIndex: number
          • array: ElasticPoolActivity[]

          Returns ElasticPoolActivity

    Returns ElasticPoolActivity

  • Parameters

    • callbackfn: function
        • (previousValue: ElasticPoolActivity, currentValue: ElasticPoolActivity, currentIndex: number, array: ElasticPoolActivity[]): ElasticPoolActivity
        • Parameters

          • previousValue: ElasticPoolActivity
          • currentValue: ElasticPoolActivity
          • currentIndex: number
          • array: ElasticPoolActivity[]

          Returns ElasticPoolActivity

    • initialValue: ElasticPoolActivity

    Returns ElasticPoolActivity

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ElasticPoolActivity, currentIndex: number, array: ElasticPoolActivity[]): U
        • Parameters

          • previousValue: U
          • currentValue: ElasticPoolActivity
          • currentIndex: number
          • array: ElasticPoolActivity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ElasticPoolActivity[]
  • Reverses the elements in an Array.

    Returns ElasticPoolActivity[]

shift

  • shift(): ElasticPoolActivity | undefined
  • Removes the first element from an array and returns it.

    Returns ElasticPoolActivity | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ElasticPoolActivity[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ElasticPoolActivity[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ElasticPoolActivity, index: number, array: ElasticPoolActivity[]): boolean
        • Parameters

          • value: ElasticPoolActivity
          • index: number
          • array: ElasticPoolActivity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ElasticPoolActivity[]
  • splice(start: number, deleteCount: number, ...items: ElasticPoolActivity[]): ElasticPoolActivity[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ElasticPoolActivity[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ElasticPoolActivity[]

      Elements to insert into the array in place of the deleted elements.

    Returns ElasticPoolActivity[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ElasticPoolActivity[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ElasticPoolActivity[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ElasticPoolActivity>
  • Returns an iterable of values in the array

    Returns IterableIterator<ElasticPoolActivity>

type

type: object

className

className: string = "ElasticPoolActivityListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ElasticPoolActivity"

name

name: "Composite" = "Composite"

Const ElasticPoolDatabaseActivity

ElasticPoolDatabaseActivity: object

Represents the activity on an elastic pool.

Optional currentElasticPoolName

currentElasticPoolName: undefined | string

The name of the current elastic pool the database is in if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional currentServiceObjective

currentServiceObjective: undefined | string

The name of the current service objective if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseName

databaseName: undefined | string

The database name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date

The time the operation finished (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorCode

errorCode: undefined | number

The error code if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorMessage

errorMessage: undefined | string

The error message if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorSeverity

errorSeverity: undefined | number

The error severity if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The geo-location where the resource lives

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operation

operation: undefined | string

The operation name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationId

operationId: undefined | string

The unique operation ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional percentComplete

percentComplete: undefined | number

The percentage complete if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestedElasticPoolName

requestedElasticPoolName: undefined | string

The name for the elastic pool the database is moving into if available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestedServiceObjective

requestedServiceObjective: undefined | string

The name of the requested service objective if available. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ElasticPoolDatabaseActivity"

Optional serverName

serverName: undefined | string

The name of the server the elastic pool is in. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date

The time the operation started (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

state: undefined | string

The current state of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ElasticPoolDatabaseActivity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentElasticPoolName

currentElasticPoolName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.currentElasticPoolName"

type

type: object

name

name: "String" = "String"

currentServiceObjective

currentServiceObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.currentServiceObjective"

type

type: object

name

name: "String" = "String"

databaseName

databaseName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseName"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

errorCode

errorCode: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorCode"

type

type: object

name

name: "Number" = "Number"

errorMessage

errorMessage: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorMessage"

type

type: object

name

name: "String" = "String"

errorSeverity

errorSeverity: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorSeverity"

type

type: object

name

name: "Number" = "Number"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

operation

operation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operation"

type

type: object

name

name: "String" = "String"

operationId

operationId: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operationId"

type

type: object

name

name: "Uuid" = "Uuid"

percentComplete

percentComplete: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.percentComplete"

type

type: object

name

name: "Number" = "Number"

requestedElasticPoolName

requestedElasticPoolName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedElasticPoolName"

type

type: object

name

name: "String" = "String"

requestedServiceObjective

requestedServiceObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestedServiceObjective"

type

type: object

name

name: "String" = "String"

serverName

serverName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serverName"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const ElasticPoolDatabaseActivityListResult

ElasticPoolDatabaseActivityListResult: object
interface

Represents the response to a list elastic pool database activity request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ElasticPoolDatabaseActivityListResult"

__@iterator

  • __@iterator(): IterableIterator<ElasticPoolDatabaseActivity>
  • Iterator

    Returns IterableIterator<ElasticPoolDatabaseActivity>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ElasticPoolDatabaseActivity>[]): ElasticPoolDatabaseActivity[]
  • concat(...items: (T | ConcatArray<T>)[]): ElasticPoolDatabaseActivity[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ElasticPoolDatabaseActivity>[]

      Additional items to add to the end of array1.

    Returns ElasticPoolDatabaseActivity[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ElasticPoolDatabaseActivity[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ElasticPoolDatabaseActivity]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ElasticPoolDatabaseActivity]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ElasticPoolDatabaseActivity, index: number, array: ElasticPoolDatabaseActivity[]): boolean
        • Parameters

          • value: ElasticPoolDatabaseActivity
          • index: number
          • array: ElasticPoolDatabaseActivity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ElasticPoolDatabaseActivity, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ElasticPoolDatabaseActivity

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ElasticPoolDatabaseActivity[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ElasticPoolDatabaseActivity

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ElasticPoolDatabaseActivity, index: number, array: ElasticPoolDatabaseActivity[]): boolean
        • Parameters

          • value: ElasticPoolDatabaseActivity
          • index: number
          • array: ElasticPoolDatabaseActivity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ElasticPoolDatabaseActivity, index: number, array: ElasticPoolDatabaseActivity[]): any
        • Parameters

          • value: ElasticPoolDatabaseActivity
          • index: number
          • array: ElasticPoolDatabaseActivity[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ElasticPoolDatabaseActivity[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ElasticPoolDatabaseActivity | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ElasticPoolDatabaseActivity

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ElasticPoolDatabaseActivity, index: number, obj: ElasticPoolDatabaseActivity[]): boolean
        • Parameters

          • this: void
          • value: ElasticPoolDatabaseActivity
          • index: number
          • obj: ElasticPoolDatabaseActivity[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ElasticPoolDatabaseActivity, index: number, obj: ElasticPoolDatabaseActivity[]): boolean
        • Parameters

          • value: ElasticPoolDatabaseActivity
          • index: number
          • obj: ElasticPoolDatabaseActivity[]

          Returns boolean

    • Optional thisArg: any

    Returns ElasticPoolDatabaseActivity | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ElasticPoolDatabaseActivity, index: number, obj: ElasticPoolDatabaseActivity[]): boolean
        • Parameters

          • value: ElasticPoolDatabaseActivity
          • index: number
          • obj: ElasticPoolDatabaseActivity[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ElasticPoolDatabaseActivity, index: number, array: ElasticPoolDatabaseActivity[]): void
        • Parameters

          • value: ElasticPoolDatabaseActivity
          • index: number
          • array: ElasticPoolDatabaseActivity[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ElasticPoolDatabaseActivity, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ElasticPoolDatabaseActivity

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ElasticPoolDatabaseActivity, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ElasticPoolDatabaseActivity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ElasticPoolDatabaseActivity, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ElasticPoolDatabaseActivity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ElasticPoolDatabaseActivity, index: number, array: ElasticPoolDatabaseActivity[]): U
        • Parameters

          • value: ElasticPoolDatabaseActivity
          • index: number
          • array: ElasticPoolDatabaseActivity[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ElasticPoolDatabaseActivity | undefined
  • Removes the last element from an array and returns it.

    Returns ElasticPoolDatabaseActivity | undefined

push

  • push(...items: ElasticPoolDatabaseActivity[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ElasticPoolDatabaseActivity[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ElasticPoolDatabaseActivity
  • reduce(callbackfn: function, initialValue: ElasticPoolDatabaseActivity): ElasticPoolDatabaseActivity
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ElasticPoolDatabaseActivity, currentValue: ElasticPoolDatabaseActivity, currentIndex: number, array: ElasticPoolDatabaseActivity[]): ElasticPoolDatabaseActivity
        • Parameters

          • previousValue: ElasticPoolDatabaseActivity
          • currentValue: ElasticPoolDatabaseActivity
          • currentIndex: number
          • array: ElasticPoolDatabaseActivity[]

          Returns ElasticPoolDatabaseActivity

    Returns ElasticPoolDatabaseActivity

  • Parameters

    • callbackfn: function
        • (previousValue: ElasticPoolDatabaseActivity, currentValue: ElasticPoolDatabaseActivity, currentIndex: number, array: ElasticPoolDatabaseActivity[]): ElasticPoolDatabaseActivity
        • Parameters

          • previousValue: ElasticPoolDatabaseActivity
          • currentValue: ElasticPoolDatabaseActivity
          • currentIndex: number
          • array: ElasticPoolDatabaseActivity[]

          Returns ElasticPoolDatabaseActivity

    • initialValue: ElasticPoolDatabaseActivity

    Returns ElasticPoolDatabaseActivity

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ElasticPoolDatabaseActivity, currentIndex: number, array: ElasticPoolDatabaseActivity[]): U
        • Parameters

          • previousValue: U
          • currentValue: ElasticPoolDatabaseActivity
          • currentIndex: number
          • array: ElasticPoolDatabaseActivity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ElasticPoolDatabaseActivity
  • reduceRight(callbackfn: function, initialValue: ElasticPoolDatabaseActivity): ElasticPoolDatabaseActivity
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ElasticPoolDatabaseActivity, currentValue: ElasticPoolDatabaseActivity, currentIndex: number, array: ElasticPoolDatabaseActivity[]): ElasticPoolDatabaseActivity
        • Parameters

          • previousValue: ElasticPoolDatabaseActivity
          • currentValue: ElasticPoolDatabaseActivity
          • currentIndex: number
          • array: ElasticPoolDatabaseActivity[]

          Returns ElasticPoolDatabaseActivity

    Returns ElasticPoolDatabaseActivity

  • Parameters

    • callbackfn: function
        • (previousValue: ElasticPoolDatabaseActivity, currentValue: ElasticPoolDatabaseActivity, currentIndex: number, array: ElasticPoolDatabaseActivity[]): ElasticPoolDatabaseActivity
        • Parameters

          • previousValue: ElasticPoolDatabaseActivity
          • currentValue: ElasticPoolDatabaseActivity
          • currentIndex: number
          • array: ElasticPoolDatabaseActivity[]

          Returns ElasticPoolDatabaseActivity

    • initialValue: ElasticPoolDatabaseActivity

    Returns ElasticPoolDatabaseActivity

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ElasticPoolDatabaseActivity, currentIndex: number, array: ElasticPoolDatabaseActivity[]): U
        • Parameters

          • previousValue: U
          • currentValue: ElasticPoolDatabaseActivity
          • currentIndex: number
          • array: ElasticPoolDatabaseActivity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ElasticPoolDatabaseActivity[]
  • Reverses the elements in an Array.

    Returns ElasticPoolDatabaseActivity[]

shift

  • shift(): ElasticPoolDatabaseActivity | undefined
  • Removes the first element from an array and returns it.

    Returns ElasticPoolDatabaseActivity | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ElasticPoolDatabaseActivity[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ElasticPoolDatabaseActivity[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ElasticPoolDatabaseActivity, index: number, array: ElasticPoolDatabaseActivity[]): boolean
        • Parameters

          • value: ElasticPoolDatabaseActivity
          • index: number
          • array: ElasticPoolDatabaseActivity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ElasticPoolDatabaseActivity[]
  • splice(start: number, deleteCount: number, ...items: ElasticPoolDatabaseActivity[]): ElasticPoolDatabaseActivity[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ElasticPoolDatabaseActivity[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ElasticPoolDatabaseActivity[]

      Elements to insert into the array in place of the deleted elements.

    Returns ElasticPoolDatabaseActivity[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ElasticPoolDatabaseActivity[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ElasticPoolDatabaseActivity[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ElasticPoolDatabaseActivity>
  • Returns an iterable of values in the array

    Returns IterableIterator<ElasticPoolDatabaseActivity>

type

type: object

className

className: string = "ElasticPoolDatabaseActivityListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ElasticPoolDatabaseActivity"

name

name: "Composite" = "Composite"

Const ElasticPoolEditionCapability

ElasticPoolEditionCapability: object

The elastic pool edition capability.

Optional name

name: undefined | string

The elastic pool edition name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "ElasticPoolEditionCapability"

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedElasticPoolPerformanceLevels

supportedElasticPoolPerformanceLevels: ElasticPoolPerformanceLevelCapability[]

The list of supported elastic pool DTU levels for the edition. NOTE: This property will not be serialized. It can only be populated by the server.

Optional zoneRedundant

zoneRedundant: undefined | false | true

Whether or not zone redundancy is supported for the edition. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ElasticPoolEditionCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

supportedElasticPoolPerformanceLevels

supportedElasticPoolPerformanceLevels: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedElasticPoolPerformanceLevels"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ElasticPoolPerformanceLevelCapability"

name

name: "Composite" = "Composite"

zoneRedundant

zoneRedundant: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "zoneRedundant"

type

type: object

name

name: "Boolean" = "Boolean"

Const ElasticPoolListResult

ElasticPoolListResult: object
interface

The result of an elastic pool list request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ElasticPoolListResult"

__@iterator

  • __@iterator(): IterableIterator<ElasticPool>
  • Iterator

    Returns IterableIterator<ElasticPool>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ElasticPool>[]): ElasticPool[]
  • concat(...items: (T | ConcatArray<T>)[]): ElasticPool[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ElasticPool>[]

      Additional items to add to the end of array1.

    Returns ElasticPool[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ElasticPool[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ElasticPool]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ElasticPool]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ElasticPool, index: number, array: ElasticPool[]): boolean
        • Parameters

          • value: ElasticPool
          • index: number
          • array: ElasticPool[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ElasticPool, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ElasticPool

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ElasticPool[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ElasticPool

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ElasticPool, index: number, array: ElasticPool[]): boolean
        • Parameters

          • value: ElasticPool
          • index: number
          • array: ElasticPool[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ElasticPool, index: number, array: ElasticPool[]): any
        • Parameters

          • value: ElasticPool
          • index: number
          • array: ElasticPool[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ElasticPool[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ElasticPool | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ElasticPool

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ElasticPool, index: number, obj: ElasticPool[]): boolean
        • Parameters

          • this: void
          • value: ElasticPool
          • index: number
          • obj: ElasticPool[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ElasticPool, index: number, obj: ElasticPool[]): boolean
        • Parameters

          • value: ElasticPool
          • index: number
          • obj: ElasticPool[]

          Returns boolean

    • Optional thisArg: any

    Returns ElasticPool | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ElasticPool, index: number, obj: ElasticPool[]): boolean
        • Parameters

          • value: ElasticPool
          • index: number
          • obj: ElasticPool[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ElasticPool, index: number, array: ElasticPool[]): void
        • Parameters

          • value: ElasticPool
          • index: number
          • array: ElasticPool[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ElasticPool, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ElasticPool

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ElasticPool, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ElasticPool

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ElasticPool, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ElasticPool

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ElasticPool, index: number, array: ElasticPool[]): U
        • Parameters

          • value: ElasticPool
          • index: number
          • array: ElasticPool[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ElasticPool | undefined
  • Removes the last element from an array and returns it.

    Returns ElasticPool | undefined

push

  • push(...items: ElasticPool[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ElasticPool[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ElasticPool
  • reduce(callbackfn: function, initialValue: ElasticPool): ElasticPool
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ElasticPool, currentValue: ElasticPool, currentIndex: number, array: ElasticPool[]): ElasticPool
        • Parameters

          • previousValue: ElasticPool
          • currentValue: ElasticPool
          • currentIndex: number
          • array: ElasticPool[]

          Returns ElasticPool

    Returns ElasticPool

  • Parameters

    • callbackfn: function
        • (previousValue: ElasticPool, currentValue: ElasticPool, currentIndex: number, array: ElasticPool[]): ElasticPool
        • Parameters

          • previousValue: ElasticPool
          • currentValue: ElasticPool
          • currentIndex: number
          • array: ElasticPool[]

          Returns ElasticPool

    • initialValue: ElasticPool

    Returns ElasticPool

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ElasticPool, currentIndex: number, array: ElasticPool[]): U
        • Parameters

          • previousValue: U
          • currentValue: ElasticPool
          • currentIndex: number
          • array: ElasticPool[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ElasticPool
  • reduceRight(callbackfn: function, initialValue: ElasticPool): ElasticPool
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ElasticPool, currentValue: ElasticPool, currentIndex: number, array: ElasticPool[]): ElasticPool
        • Parameters

          • previousValue: ElasticPool
          • currentValue: ElasticPool
          • currentIndex: number
          • array: ElasticPool[]

          Returns ElasticPool

    Returns ElasticPool

  • Parameters

    • callbackfn: function
        • (previousValue: ElasticPool, currentValue: ElasticPool, currentIndex: number, array: ElasticPool[]): ElasticPool
        • Parameters

          • previousValue: ElasticPool
          • currentValue: ElasticPool
          • currentIndex: number
          • array: ElasticPool[]

          Returns ElasticPool

    • initialValue: ElasticPool

    Returns ElasticPool

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ElasticPool, currentIndex: number, array: ElasticPool[]): U
        • Parameters

          • previousValue: U
          • currentValue: ElasticPool
          • currentIndex: number
          • array: ElasticPool[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ElasticPool[]
  • Reverses the elements in an Array.

    Returns ElasticPool[]

shift

  • shift(): ElasticPool | undefined
  • Removes the first element from an array and returns it.

    Returns ElasticPool | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ElasticPool[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ElasticPool[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ElasticPool, index: number, array: ElasticPool[]): boolean
        • Parameters

          • value: ElasticPool
          • index: number
          • array: ElasticPool[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ElasticPool[]
  • splice(start: number, deleteCount: number, ...items: ElasticPool[]): ElasticPool[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ElasticPool[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ElasticPool[]

      Elements to insert into the array in place of the deleted elements.

    Returns ElasticPool[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ElasticPool[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ElasticPool[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ElasticPool>
  • Returns an iterable of values in the array

    Returns IterableIterator<ElasticPool>

type

type: object

className

className: string = "ElasticPoolListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ElasticPool"

name

name: "Composite" = "Composite"

Const ElasticPoolOperation

ElasticPoolOperation: object

A elastic pool operation.

Optional description

description: undefined | string

The operation description. NOTE: This property will not be serialized. It can only be populated by the server.

Optional elasticPoolName

elasticPoolName: undefined | string

The name of the elastic pool the operation is being performed on. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorCode

errorCode: undefined | number

The operation error code. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorDescription

errorDescription: undefined | string

The operation error description. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorSeverity

errorSeverity: undefined | number

The operation error severity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional estimatedCompletionTime

estimatedCompletionTime: Date

The estimated completion time of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isCancellable

isCancellable: undefined | false | true

Whether the operation can be cancelled. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isUserError

isUserError: undefined | false | true

Whether or not the error is a user error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operation

operation: undefined | string

The name of operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationFriendlyName

operationFriendlyName: undefined | string

The friendly name of operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional percentComplete

percentComplete: undefined | number

The percentage of the operation completed. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ElasticPoolOperation"

Optional serverName

serverName: undefined | string

The name of the server. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date

The operation start time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

state: undefined | string

The operation state. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ElasticPoolOperation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

elasticPoolName

elasticPoolName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.elasticPoolName"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorCode"

type

type: object

name

name: "Number" = "Number"

errorDescription

errorDescription: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorDescription"

type

type: object

name

name: "String" = "String"

errorSeverity

errorSeverity: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorSeverity"

type

type: object

name

name: "Number" = "Number"

estimatedCompletionTime

estimatedCompletionTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.estimatedCompletionTime"

type

type: object

name

name: "DateTime" = "DateTime"

isCancellable

isCancellable: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isCancellable"

type

type: object

name

name: "Boolean" = "Boolean"

isUserError

isUserError: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isUserError"

type

type: object

name

name: "Boolean" = "Boolean"

operation

operation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operation"

type

type: object

name

name: "String" = "String"

operationFriendlyName

operationFriendlyName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operationFriendlyName"

type

type: object

name

name: "String" = "String"

percentComplete

percentComplete: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.percentComplete"

type

type: object

name

name: "Number" = "Number"

serverName

serverName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serverName"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const ElasticPoolOperationListResult

ElasticPoolOperationListResult: object
interface

The response to a list elastic pool operations request

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ElasticPoolOperationListResult"

__@iterator

  • __@iterator(): IterableIterator<ElasticPoolOperation>
  • Iterator

    Returns IterableIterator<ElasticPoolOperation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ElasticPoolOperation>[]): ElasticPoolOperation[]
  • concat(...items: (T | ConcatArray<T>)[]): ElasticPoolOperation[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ElasticPoolOperation>[]

      Additional items to add to the end of array1.

    Returns ElasticPoolOperation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ElasticPoolOperation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ElasticPoolOperation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ElasticPoolOperation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ElasticPoolOperation, index: number, array: ElasticPoolOperation[]): boolean
        • Parameters

          • value: ElasticPoolOperation
          • index: number
          • array: ElasticPoolOperation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ElasticPoolOperation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ElasticPoolOperation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ElasticPoolOperation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ElasticPoolOperation

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ElasticPoolOperation, index: number, array: ElasticPoolOperation[]): boolean
        • Parameters

          • value: ElasticPoolOperation
          • index: number
          • array: ElasticPoolOperation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ElasticPoolOperation, index: number, array: ElasticPoolOperation[]): any
        • Parameters

          • value: ElasticPoolOperation
          • index: number
          • array: ElasticPoolOperation[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ElasticPoolOperation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ElasticPoolOperation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ElasticPoolOperation

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ElasticPoolOperation, index: number, obj: ElasticPoolOperation[]): boolean
        • Parameters

          • this: void
          • value: ElasticPoolOperation
          • index: number
          • obj: ElasticPoolOperation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ElasticPoolOperation, index: number, obj: ElasticPoolOperation[]): boolean
        • Parameters

          • value: ElasticPoolOperation
          • index: number
          • obj: ElasticPoolOperation[]

          Returns boolean

    • Optional thisArg: any

    Returns ElasticPoolOperation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ElasticPoolOperation, index: number, obj: ElasticPoolOperation[]): boolean
        • Parameters

          • value: ElasticPoolOperation
          • index: number
          • obj: ElasticPoolOperation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ElasticPoolOperation, index: number, array: ElasticPoolOperation[]): void
        • Parameters

          • value: ElasticPoolOperation
          • index: number
          • array: ElasticPoolOperation[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ElasticPoolOperation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ElasticPoolOperation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ElasticPoolOperation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ElasticPoolOperation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ElasticPoolOperation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ElasticPoolOperation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ElasticPoolOperation, index: number, array: ElasticPoolOperation[]): U
        • Parameters

          • value: ElasticPoolOperation
          • index: number
          • array: ElasticPoolOperation[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ElasticPoolOperation | undefined
  • Removes the last element from an array and returns it.

    Returns ElasticPoolOperation | undefined

push

  • push(...items: ElasticPoolOperation[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ElasticPoolOperation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ElasticPoolOperation
  • reduce(callbackfn: function, initialValue: ElasticPoolOperation): ElasticPoolOperation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ElasticPoolOperation, currentValue: ElasticPoolOperation, currentIndex: number, array: ElasticPoolOperation[]): ElasticPoolOperation
        • Parameters

          • previousValue: ElasticPoolOperation
          • currentValue: ElasticPoolOperation
          • currentIndex: number
          • array: ElasticPoolOperation[]

          Returns ElasticPoolOperation

    Returns ElasticPoolOperation

  • Parameters

    • callbackfn: function
        • (previousValue: ElasticPoolOperation, currentValue: ElasticPoolOperation, currentIndex: number, array: ElasticPoolOperation[]): ElasticPoolOperation
        • Parameters

          • previousValue: ElasticPoolOperation
          • currentValue: ElasticPoolOperation
          • currentIndex: number
          • array: ElasticPoolOperation[]

          Returns ElasticPoolOperation

    • initialValue: ElasticPoolOperation

    Returns ElasticPoolOperation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ElasticPoolOperation, currentIndex: number, array: ElasticPoolOperation[]): U
        • Parameters

          • previousValue: U
          • currentValue: ElasticPoolOperation
          • currentIndex: number
          • array: ElasticPoolOperation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ElasticPoolOperation
  • reduceRight(callbackfn: function, initialValue: ElasticPoolOperation): ElasticPoolOperation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ElasticPoolOperation, currentValue: ElasticPoolOperation, currentIndex: number, array: ElasticPoolOperation[]): ElasticPoolOperation
        • Parameters

          • previousValue: ElasticPoolOperation
          • currentValue: ElasticPoolOperation
          • currentIndex: number
          • array: ElasticPoolOperation[]

          Returns ElasticPoolOperation

    Returns ElasticPoolOperation

  • Parameters

    • callbackfn: function
        • (previousValue: ElasticPoolOperation, currentValue: ElasticPoolOperation, currentIndex: number, array: ElasticPoolOperation[]): ElasticPoolOperation
        • Parameters

          • previousValue: ElasticPoolOperation
          • currentValue: ElasticPoolOperation
          • currentIndex: number
          • array: ElasticPoolOperation[]

          Returns ElasticPoolOperation

    • initialValue: ElasticPoolOperation

    Returns ElasticPoolOperation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ElasticPoolOperation, currentIndex: number, array: ElasticPoolOperation[]): U
        • Parameters

          • previousValue: U
          • currentValue: ElasticPoolOperation
          • currentIndex: number
          • array: ElasticPoolOperation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ElasticPoolOperation[]
  • Reverses the elements in an Array.

    Returns ElasticPoolOperation[]

shift

  • shift(): ElasticPoolOperation | undefined
  • Removes the first element from an array and returns it.

    Returns ElasticPoolOperation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ElasticPoolOperation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ElasticPoolOperation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ElasticPoolOperation, index: number, array: ElasticPoolOperation[]): boolean
        • Parameters

          • value: ElasticPoolOperation
          • index: number
          • array: ElasticPoolOperation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ElasticPoolOperation[]
  • splice(start: number, deleteCount: number, ...items: ElasticPoolOperation[]): ElasticPoolOperation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ElasticPoolOperation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ElasticPoolOperation[]

      Elements to insert into the array in place of the deleted elements.

    Returns ElasticPoolOperation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ElasticPoolOperation[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ElasticPoolOperation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ElasticPoolOperation>
  • Returns an iterable of values in the array

    Returns IterableIterator<ElasticPoolOperation>

type

type: object

className

className: string = "ElasticPoolOperationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ElasticPoolOperation"

name

name: "Composite" = "Composite"

Const ElasticPoolPerDatabaseMaxPerformanceLevelCapability

ElasticPoolPerDatabaseMaxPerformanceLevelCapability: object

The max per-database performance level capability.

Optional limit

limit: undefined | number

The maximum performance level per database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "ElasticPoolPerDatabaseMaxPerformanceLevelCapability"

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedPerDatabaseMinPerformanceLevels

supportedPerDatabaseMinPerformanceLevels: ElasticPoolPerDatabaseMinPerformanceLevelCapability[]

The list of supported min database performance levels. NOTE: This property will not be serialized. It can only be populated by the server.

Optional unit

Unit type used to measure performance level. Possible values include: 'DTU', 'VCores' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ElasticPoolPerDatabaseMaxPerformanceLevelCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

limit

limit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "limit"

type

type: object

name

name: "Number" = "Number"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

supportedPerDatabaseMinPerformanceLevels

supportedPerDatabaseMinPerformanceLevels: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedPerDatabaseMinPerformanceLevels"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ElasticPoolPerDatabaseMinPerformanceLevelCapability"

name

name: "Composite" = "Composite"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const ElasticPoolPerDatabaseMinPerformanceLevelCapability

ElasticPoolPerDatabaseMinPerformanceLevelCapability: object

The minimum per-database performance level capability.

Optional limit

limit: undefined | number

The minimum performance level per database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "ElasticPoolPerDatabaseMinPerformanceLevelCapability"

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional unit

Unit type used to measure performance level. Possible values include: 'DTU', 'VCores' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ElasticPoolPerDatabaseMinPerformanceLevelCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

limit

limit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "limit"

type

type: object

name

name: "Number" = "Number"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const ElasticPoolPerDatabaseSettings

ElasticPoolPerDatabaseSettings: object

Per database settings of an elastic pool.

Optional maxCapacity

maxCapacity: undefined | number

The maximum capacity any one database can consume.

Optional minCapacity

minCapacity: undefined | number

The minimum capacity all databases are guaranteed.

serializedName

serializedName: string = "ElasticPoolPerDatabaseSettings"

type

type: object

className

className: string = "ElasticPoolPerDatabaseSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

maxCapacity

maxCapacity: object

serializedName

serializedName: string = "maxCapacity"

type

type: object

name

name: "Number" = "Number"

minCapacity

minCapacity: object

serializedName

serializedName: string = "minCapacity"

type

type: object

name

name: "Number" = "Number"

Const ElasticPoolPerformanceLevelCapability

ElasticPoolPerformanceLevelCapability: object

The Elastic Pool performance level capability.

Optional includedMaxSize

includedMaxSize: MaxSizeCapability

The included (free) max size for this performance level. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxDatabaseCount

maxDatabaseCount: undefined | number

The maximum number of databases supported. NOTE: This property will not be serialized. It can only be populated by the server.

Optional performanceLevel

performanceLevel: PerformanceLevelCapability

The performance level for the pool. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "ElasticPoolPerformanceLevelCapability"

Optional sku

sku: Sku

The sku. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedLicenseTypes

supportedLicenseTypes: LicenseTypeCapability[]

List of supported license types. NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedMaxSizes

supportedMaxSizes: MaxSizeRangeCapability[]

The list of supported max sizes. NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedPerDatabaseMaxPerformanceLevels

supportedPerDatabaseMaxPerformanceLevels: ElasticPoolPerDatabaseMaxPerformanceLevelCapability[]

The list of supported per database max performance levels. NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedPerDatabaseMaxSizes

supportedPerDatabaseMaxSizes: MaxSizeRangeCapability[]

The list of supported per database max sizes. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ElasticPoolPerformanceLevelCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

includedMaxSize

includedMaxSize: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "includedMaxSize"

type

type: object

className

className: string = "MaxSizeCapability"

name

name: "Composite" = "Composite"

maxDatabaseCount

maxDatabaseCount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "maxDatabaseCount"

type

type: object

name

name: "Number" = "Number"

performanceLevel

performanceLevel: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "performanceLevel"

type

type: object

className

className: string = "PerformanceLevelCapability"

name

name: "Composite" = "Composite"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

sku

sku: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

supportedLicenseTypes

supportedLicenseTypes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedLicenseTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LicenseTypeCapability"

name

name: "Composite" = "Composite"

supportedMaxSizes

supportedMaxSizes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedMaxSizes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MaxSizeRangeCapability"

name

name: "Composite" = "Composite"

supportedPerDatabaseMaxPerformanceLevels

supportedPerDatabaseMaxPerformanceLevels: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedPerDatabaseMaxPerformanceLevels"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ElasticPoolPerDatabaseMaxPerformanceLevelCapability"

name

name: "Composite" = "Composite"

supportedPerDatabaseMaxSizes

supportedPerDatabaseMaxSizes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedPerDatabaseMaxSizes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MaxSizeRangeCapability"

name

name: "Composite" = "Composite"

Const ElasticPoolUpdate

ElasticPoolUpdate: object

An elastic pool update.

Optional licenseType

The license type to apply for this elastic pool. Possible values include: 'LicenseIncluded', 'BasePrice'

Optional maxSizeBytes

maxSizeBytes: undefined | number

The storage limit for the database elastic pool in bytes.

Optional perDatabaseSettings

perDatabaseSettings: ElasticPoolPerDatabaseSettings

The per database settings for the elastic pool.

serializedName

serializedName: string = "ElasticPoolUpdate"

Optional sku

sku: Sku

Optional tags

tags: undefined | object

Resource tags.

Optional zoneRedundant

zoneRedundant: undefined | false | true

Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

type

type: object

className

className: string = "ElasticPoolUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

licenseType

licenseType: object

serializedName

serializedName: string = "properties.licenseType"

type

type: object

name

name: "String" = "String"

maxSizeBytes

maxSizeBytes: object

serializedName

serializedName: string = "properties.maxSizeBytes"

type

type: object

name

name: "Number" = "Number"

perDatabaseSettings

perDatabaseSettings: object

serializedName

serializedName: string = "properties.perDatabaseSettings"

type

type: object

className

className: string = "ElasticPoolPerDatabaseSettings"

name

name: "Composite" = "Composite"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

zoneRedundant

zoneRedundant: object

serializedName

serializedName: string = "properties.zoneRedundant"

type

type: object

name

name: "Boolean" = "Boolean"

Const EncryptionProtector

EncryptionProtector: object

The server encryption protector.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of encryption protector. This is metadata used for the Azure portal experience.

Optional location

location: undefined | string

Resource location. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "EncryptionProtector"

Optional serverKeyName

serverKeyName: undefined | string

The name of the server key.

serverKeyType

serverKeyType: ServerKeyType

The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. Possible values include: 'ServiceManaged', 'AzureKeyVault'

Optional subregion

subregion: undefined | string

Subregion of the encryption protector. NOTE: This property will not be serialized. It can only be populated by the server.

Optional thumbprint

thumbprint: undefined | string

Thumbprint of the server key. NOTE: This property will not be serialized. It can only be populated by the server.

Optional uri

uri: undefined | string

The URI of the server key. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "EncryptionProtector"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

kind

kind: object

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

serverKeyName

serverKeyName: object

serializedName

serializedName: string = "properties.serverKeyName"

type

type: object

name

name: "String" = "String"

serverKeyType

serverKeyType: object

required

required: true = true

serializedName

serializedName: string = "properties.serverKeyType"

type

type: object

name

name: "String" = "String"

subregion

subregion: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subregion"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

uri

uri: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uri"

type

type: object

name

name: "String" = "String"

Const EncryptionProtectorListResult

EncryptionProtectorListResult: object
interface

A list of server encryption protectors.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "EncryptionProtectorListResult"

__@iterator

  • __@iterator(): IterableIterator<EncryptionProtector>
  • Iterator

    Returns IterableIterator<EncryptionProtector>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<EncryptionProtector>[]): EncryptionProtector[]
  • concat(...items: (T | ConcatArray<T>)[]): EncryptionProtector[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<EncryptionProtector>[]

      Additional items to add to the end of array1.

    Returns EncryptionProtector[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns EncryptionProtector[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, EncryptionProtector]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, EncryptionProtector]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: EncryptionProtector, index: number, array: EncryptionProtector[]): boolean
        • Parameters

          • value: EncryptionProtector
          • index: number
          • array: EncryptionProtector[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: EncryptionProtector, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: EncryptionProtector

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): EncryptionProtector[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: EncryptionProtector

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: EncryptionProtector, index: number, array: EncryptionProtector[]): boolean
        • Parameters

          • value: EncryptionProtector
          • index: number
          • array: EncryptionProtector[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: EncryptionProtector, index: number, array: EncryptionProtector[]): any
        • Parameters

          • value: EncryptionProtector
          • index: number
          • array: EncryptionProtector[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns EncryptionProtector[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): EncryptionProtector | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: EncryptionProtector

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: EncryptionProtector, index: number, obj: EncryptionProtector[]): boolean
        • Parameters

          • this: void
          • value: EncryptionProtector
          • index: number
          • obj: EncryptionProtector[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: EncryptionProtector, index: number, obj: EncryptionProtector[]): boolean
        • Parameters

          • value: EncryptionProtector
          • index: number
          • obj: EncryptionProtector[]

          Returns boolean

    • Optional thisArg: any

    Returns EncryptionProtector | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: EncryptionProtector, index: number, obj: EncryptionProtector[]): boolean
        • Parameters

          • value: EncryptionProtector
          • index: number
          • obj: EncryptionProtector[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: EncryptionProtector, index: number, array: EncryptionProtector[]): void
        • Parameters

          • value: EncryptionProtector
          • index: number
          • array: EncryptionProtector[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: EncryptionProtector, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: EncryptionProtector

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: EncryptionProtector, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: EncryptionProtector

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: EncryptionProtector, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: EncryptionProtector

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: EncryptionProtector, index: number, array: EncryptionProtector[]): U
        • Parameters

          • value: EncryptionProtector
          • index: number
          • array: EncryptionProtector[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): EncryptionProtector | undefined
  • Removes the last element from an array and returns it.

    Returns EncryptionProtector | undefined

push

  • push(...items: EncryptionProtector[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: EncryptionProtector[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): EncryptionProtector
  • reduce(callbackfn: function, initialValue: EncryptionProtector): EncryptionProtector
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: EncryptionProtector, currentValue: EncryptionProtector, currentIndex: number, array: EncryptionProtector[]): EncryptionProtector
        • Parameters

          • previousValue: EncryptionProtector
          • currentValue: EncryptionProtector
          • currentIndex: number
          • array: EncryptionProtector[]

          Returns EncryptionProtector

    Returns EncryptionProtector

  • Parameters

    • callbackfn: function
        • (previousValue: EncryptionProtector, currentValue: EncryptionProtector, currentIndex: number, array: EncryptionProtector[]): EncryptionProtector
        • Parameters

          • previousValue: EncryptionProtector
          • currentValue: EncryptionProtector
          • currentIndex: number
          • array: EncryptionProtector[]

          Returns EncryptionProtector

    • initialValue: EncryptionProtector

    Returns EncryptionProtector

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: EncryptionProtector, currentIndex: number, array: EncryptionProtector[]): U
        • Parameters

          • previousValue: U
          • currentValue: EncryptionProtector
          • currentIndex: number
          • array: EncryptionProtector[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): EncryptionProtector
  • reduceRight(callbackfn: function, initialValue: EncryptionProtector): EncryptionProtector
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: EncryptionProtector, currentValue: EncryptionProtector, currentIndex: number, array: EncryptionProtector[]): EncryptionProtector
        • Parameters

          • previousValue: EncryptionProtector
          • currentValue: EncryptionProtector
          • currentIndex: number
          • array: EncryptionProtector[]

          Returns EncryptionProtector

    Returns EncryptionProtector

  • Parameters

    • callbackfn: function
        • (previousValue: EncryptionProtector, currentValue: EncryptionProtector, currentIndex: number, array: EncryptionProtector[]): EncryptionProtector
        • Parameters

          • previousValue: EncryptionProtector
          • currentValue: EncryptionProtector
          • currentIndex: number
          • array: EncryptionProtector[]

          Returns EncryptionProtector

    • initialValue: EncryptionProtector

    Returns EncryptionProtector

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: EncryptionProtector, currentIndex: number, array: EncryptionProtector[]): U
        • Parameters

          • previousValue: U
          • currentValue: EncryptionProtector
          • currentIndex: number
          • array: EncryptionProtector[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): EncryptionProtector[]
  • Reverses the elements in an Array.

    Returns EncryptionProtector[]

shift

  • shift(): EncryptionProtector | undefined
  • Removes the first element from an array and returns it.

    Returns EncryptionProtector | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): EncryptionProtector[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns EncryptionProtector[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: EncryptionProtector, index: number, array: EncryptionProtector[]): boolean
        • Parameters

          • value: EncryptionProtector
          • index: number
          • array: EncryptionProtector[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): EncryptionProtector[]
  • splice(start: number, deleteCount: number, ...items: EncryptionProtector[]): EncryptionProtector[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns EncryptionProtector[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: EncryptionProtector[]

      Elements to insert into the array in place of the deleted elements.

    Returns EncryptionProtector[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: EncryptionProtector[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: EncryptionProtector[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<EncryptionProtector>
  • Returns an iterable of values in the array

    Returns IterableIterator<EncryptionProtector>

type

type: object

className

className: string = "EncryptionProtectorListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EncryptionProtector"

name

name: "Composite" = "Composite"

Const ExportRequest

ExportRequest: object

Export database parameters.

administratorLogin

administratorLogin: string

The name of the SQL administrator.

administratorLoginPassword

administratorLoginPassword: string

The password of the SQL administrator.

Optional authenticationType

authenticationType: AuthenticationType

The authentication type. Possible values include: 'SQL', 'ADPassword'. Default value: 'SQL'.

serializedName

serializedName: string = "ExportRequest"

storageKey

storageKey: string

The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a "?."

storageKeyType

storageKeyType: StorageKeyType

The type of the storage key to use. Possible values include: 'StorageAccessKey', 'SharedAccessKey'

storageUri

storageUri: string

The storage uri to use.

type

type: object

className

className: string = "ExportRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

administratorLogin

administratorLogin: object

required

required: true = true

serializedName

serializedName: string = "administratorLogin"

type

type: object

name

name: "String" = "String"

administratorLoginPassword

administratorLoginPassword: object

required

required: true = true

serializedName

serializedName: string = "administratorLoginPassword"

type

type: object

name

name: "String" = "String"

authenticationType

authenticationType: object

defaultValue

defaultValue: string = "SQL"

serializedName

serializedName: string = "authenticationType"

type

type: object

allowedValues

allowedValues: string[] = ["SQL","ADPassword"]

name

name: "Enum" = "Enum"

storageKey

storageKey: object

required

required: true = true

serializedName

serializedName: string = "storageKey"

type

type: object

name

name: "String" = "String"

storageKeyType

storageKeyType: object

required

required: true = true

serializedName

serializedName: string = "storageKeyType"

type

type: object

allowedValues

allowedValues: string[] = ["StorageAccessKey","SharedAccessKey"]

name

name: "Enum" = "Enum"

storageUri

storageUri: object

required

required: true = true

serializedName

serializedName: string = "storageUri"

type

type: object

name

name: "String" = "String"

Const ExtendedDatabaseBlobAuditingPolicy

ExtendedDatabaseBlobAuditingPolicy: object

An extended database blob auditing policy.

Optional auditActionsAndGroups

auditActionsAndGroups: string[]

Specifies the Actions-Groups and Actions to audit.

The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:

BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP.

This above combination is also the set that is configured by default when enabling auditing from the Azure portal.

The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):

APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP

These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.

For more information, see Database-Level Audit Action Groups.

For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES

The general form for defining an action to be audited is: {action} ON {object} BY {principal}

Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.

For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public

For more information, see Database-Level Audit Actions

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isAzureMonitorTargetEnabled

isAzureMonitorTargetEnabled: undefined | false | true

Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.

When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}.

Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview

For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

Optional isStorageSecondaryKeyInUse

isStorageSecondaryKeyInUse: undefined | false | true

Specifies whether storageAccountAccessKey value is the storage's secondary key.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional predicateExpression

predicateExpression: undefined | string

Specifies condition of where clause when creating an audit.

Optional retentionDays

retentionDays: undefined | number

Specifies the number of days to keep in the audit logs in the storage account.

serializedName

serializedName: string = "ExtendedDatabaseBlobAuditingPolicy"

state

Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Possible values include: 'Enabled', 'Disabled'

Optional storageAccountAccessKey

storageAccountAccessKey: undefined | string

Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.

Optional storageAccountSubscriptionId

storageAccountSubscriptionId: undefined | string

Specifies the blob storage subscription Id.

Optional storageEndpoint

storageEndpoint: undefined | string

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.

type

type: object

className

className: string = "ExtendedDatabaseBlobAuditingPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

auditActionsAndGroups

auditActionsAndGroups: object

serializedName

serializedName: string = "properties.auditActionsAndGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

isAzureMonitorTargetEnabled

isAzureMonitorTargetEnabled: object

serializedName

serializedName: string = "properties.isAzureMonitorTargetEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

isStorageSecondaryKeyInUse

isStorageSecondaryKeyInUse: object

serializedName

serializedName: string = "properties.isStorageSecondaryKeyInUse"

type

type: object

name

name: "Boolean" = "Boolean"

predicateExpression

predicateExpression: object

serializedName

serializedName: string = "properties.predicateExpression"

type

type: object

name

name: "String" = "String"

retentionDays

retentionDays: object

serializedName

serializedName: string = "properties.retentionDays"

type

type: object

name

name: "Number" = "Number"

state

state: object

required

required: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

storageAccountAccessKey

storageAccountAccessKey: object

serializedName

serializedName: string = "properties.storageAccountAccessKey"

type

type: object

name

name: "String" = "String"

storageAccountSubscriptionId

storageAccountSubscriptionId: object

serializedName

serializedName: string = "properties.storageAccountSubscriptionId"

type

type: object

name

name: "Uuid" = "Uuid"

storageEndpoint

storageEndpoint: object

serializedName

serializedName: string = "properties.storageEndpoint"

type

type: object

name

name: "String" = "String"

Const ExtendedServerBlobAuditingPolicy

ExtendedServerBlobAuditingPolicy: object

An extended server blob auditing policy.

Optional auditActionsAndGroups

auditActionsAndGroups: string[]

Specifies the Actions-Groups and Actions to audit.

The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:

BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP.

This above combination is also the set that is configured by default when enabling auditing from the Azure portal.

The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):

APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP

These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.

For more information, see Database-Level Audit Action Groups.

For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES

The general form for defining an action to be audited is: {action} ON {object} BY {principal}

Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.

For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public

For more information, see Database-Level Audit Actions

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isAzureMonitorTargetEnabled

isAzureMonitorTargetEnabled: undefined | false | true

Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.

When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}.

Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview

For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

Optional isStorageSecondaryKeyInUse

isStorageSecondaryKeyInUse: undefined | false | true

Specifies whether storageAccountAccessKey value is the storage's secondary key.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional predicateExpression

predicateExpression: undefined | string

Specifies condition of where clause when creating an audit.

Optional retentionDays

retentionDays: undefined | number

Specifies the number of days to keep in the audit logs in the storage account.

serializedName

serializedName: string = "ExtendedServerBlobAuditingPolicy"

state

Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Possible values include: 'Enabled', 'Disabled'

Optional storageAccountAccessKey

storageAccountAccessKey: undefined | string

Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.

Optional storageAccountSubscriptionId

storageAccountSubscriptionId: undefined | string

Specifies the blob storage subscription Id.

Optional storageEndpoint

storageEndpoint: undefined | string

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.

type

type: object

className

className: string = "ExtendedServerBlobAuditingPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

auditActionsAndGroups

auditActionsAndGroups: object

serializedName

serializedName: string = "properties.auditActionsAndGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

isAzureMonitorTargetEnabled

isAzureMonitorTargetEnabled: object

serializedName

serializedName: string = "properties.isAzureMonitorTargetEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

isStorageSecondaryKeyInUse

isStorageSecondaryKeyInUse: object

serializedName

serializedName: string = "properties.isStorageSecondaryKeyInUse"

type

type: object

name

name: "Boolean" = "Boolean"

predicateExpression

predicateExpression: object

serializedName

serializedName: string = "properties.predicateExpression"

type

type: object

name

name: "String" = "String"

retentionDays

retentionDays: object

serializedName

serializedName: string = "properties.retentionDays"

type

type: object

name

name: "Number" = "Number"

state

state: object

required

required: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

storageAccountAccessKey

storageAccountAccessKey: object

serializedName

serializedName: string = "properties.storageAccountAccessKey"

type

type: object

name

name: "String" = "String"

storageAccountSubscriptionId

storageAccountSubscriptionId: object

serializedName

serializedName: string = "properties.storageAccountSubscriptionId"

type

type: object

name

name: "Uuid" = "Uuid"

storageEndpoint

storageEndpoint: object

serializedName

serializedName: string = "properties.storageEndpoint"

type

type: object

name

name: "String" = "String"

Const FailoverGroup

FailoverGroup: object

A failover group.

Optional databases

databases: string[]

List of databases in the failover group.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

Resource location. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

partnerServers

partnerServers: PartnerInfo[]

List of partner server information for the failover group.

Optional readOnlyEndpoint

Read-only endpoint of the failover group instance.

readWriteEndpoint

readWriteEndpoint: FailoverGroupReadWriteEndpoint

Read-write endpoint of the failover group instance.

Optional replicationRole

Local replication role of the failover group instance. Possible values include: 'Primary', 'Secondary' NOTE: This property will not be serialized. It can only be populated by the server.

Optional replicationState

replicationState: undefined | string

Replication state of the failover group instance. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "FailoverGroup"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "FailoverGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

databases

databases: object

serializedName

serializedName: string = "properties.databases"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

partnerServers

partnerServers: object

required

required: true = true

serializedName

serializedName: string = "properties.partnerServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PartnerInfo"

name

name: "Composite" = "Composite"

readOnlyEndpoint

readOnlyEndpoint: object

serializedName

serializedName: string = "properties.readOnlyEndpoint"

type

type: object

className

className: string = "FailoverGroupReadOnlyEndpoint"

name

name: "Composite" = "Composite"

readWriteEndpoint

readWriteEndpoint: object

required

required: true = true

serializedName

serializedName: string = "properties.readWriteEndpoint"

type

type: object

className

className: string = "FailoverGroupReadWriteEndpoint"

name

name: "Composite" = "Composite"

replicationRole

replicationRole: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.replicationRole"

type

type: object

name

name: "String" = "String"

replicationState

replicationState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.replicationState"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const FailoverGroupListResult

FailoverGroupListResult: object
interface

A list of failover groups.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "FailoverGroupListResult"

__@iterator

  • __@iterator(): IterableIterator<FailoverGroup>
  • Iterator

    Returns IterableIterator<FailoverGroup>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<FailoverGroup>[]): FailoverGroup[]
  • concat(...items: (T | ConcatArray<T>)[]): FailoverGroup[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<FailoverGroup>[]

      Additional items to add to the end of array1.

    Returns FailoverGroup[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns FailoverGroup[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, FailoverGroup]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, FailoverGroup]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: FailoverGroup, index: number, array: FailoverGroup[]): boolean
        • Parameters

          • value: FailoverGroup
          • index: number
          • array: FailoverGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: FailoverGroup, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: FailoverGroup

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): FailoverGroup[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: FailoverGroup

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FailoverGroup, index: number, array: FailoverGroup[]): boolean
        • Parameters

          • value: FailoverGroup
          • index: number
          • array: FailoverGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FailoverGroup, index: number, array: FailoverGroup[]): any
        • Parameters

          • value: FailoverGroup
          • index: number
          • array: FailoverGroup[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns FailoverGroup[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): FailoverGroup | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: FailoverGroup

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: FailoverGroup, index: number, obj: FailoverGroup[]): boolean
        • Parameters

          • this: void
          • value: FailoverGroup
          • index: number
          • obj: FailoverGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: FailoverGroup, index: number, obj: FailoverGroup[]): boolean
        • Parameters

          • value: FailoverGroup
          • index: number
          • obj: FailoverGroup[]

          Returns boolean

    • Optional thisArg: any

    Returns FailoverGroup | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: FailoverGroup, index: number, obj: FailoverGroup[]): boolean
        • Parameters

          • value: FailoverGroup
          • index: number
          • obj: FailoverGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: FailoverGroup, index: number, array: FailoverGroup[]): void
        • Parameters

          • value: FailoverGroup
          • index: number
          • array: FailoverGroup[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: FailoverGroup, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: FailoverGroup

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: FailoverGroup, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: FailoverGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: FailoverGroup, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: FailoverGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: FailoverGroup, index: number, array: FailoverGroup[]): U
        • Parameters

          • value: FailoverGroup
          • index: number
          • array: FailoverGroup[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): FailoverGroup | undefined
  • Removes the last element from an array and returns it.

    Returns FailoverGroup | undefined

push

  • push(...items: FailoverGroup[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: FailoverGroup[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): FailoverGroup
  • reduce(callbackfn: function, initialValue: FailoverGroup): FailoverGroup
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: FailoverGroup, currentValue: FailoverGroup, currentIndex: number, array: FailoverGroup[]): FailoverGroup
        • Parameters

          • previousValue: FailoverGroup
          • currentValue: FailoverGroup
          • currentIndex: number
          • array: FailoverGroup[]

          Returns FailoverGroup

    Returns FailoverGroup

  • Parameters

    • callbackfn: function
        • (previousValue: FailoverGroup, currentValue: FailoverGroup, currentIndex: number, array: FailoverGroup[]): FailoverGroup
        • Parameters

          • previousValue: FailoverGroup
          • currentValue: FailoverGroup
          • currentIndex: number
          • array: FailoverGroup[]

          Returns FailoverGroup

    • initialValue: FailoverGroup

    Returns FailoverGroup

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FailoverGroup, currentIndex: number, array: FailoverGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: FailoverGroup
          • currentIndex: number
          • array: FailoverGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): FailoverGroup
  • reduceRight(callbackfn: function, initialValue: FailoverGroup): FailoverGroup
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: FailoverGroup, currentValue: FailoverGroup, currentIndex: number, array: FailoverGroup[]): FailoverGroup
        • Parameters

          • previousValue: FailoverGroup
          • currentValue: FailoverGroup
          • currentIndex: number
          • array: FailoverGroup[]

          Returns FailoverGroup

    Returns FailoverGroup

  • Parameters

    • callbackfn: function
        • (previousValue: FailoverGroup, currentValue: FailoverGroup, currentIndex: number, array: FailoverGroup[]): FailoverGroup
        • Parameters

          • previousValue: FailoverGroup
          • currentValue: FailoverGroup
          • currentIndex: number
          • array: FailoverGroup[]

          Returns FailoverGroup

    • initialValue: FailoverGroup

    Returns FailoverGroup

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FailoverGroup, currentIndex: number, array: FailoverGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: FailoverGroup
          • currentIndex: number
          • array: FailoverGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): FailoverGroup[]
  • Reverses the elements in an Array.

    Returns FailoverGroup[]

shift

  • shift(): FailoverGroup | undefined
  • Removes the first element from an array and returns it.

    Returns FailoverGroup | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): FailoverGroup[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns FailoverGroup[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: FailoverGroup, index: number, array: FailoverGroup[]): boolean
        • Parameters

          • value: FailoverGroup
          • index: number
          • array: FailoverGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): FailoverGroup[]
  • splice(start: number, deleteCount: number, ...items: FailoverGroup[]): FailoverGroup[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns FailoverGroup[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: FailoverGroup[]

      Elements to insert into the array in place of the deleted elements.

    Returns FailoverGroup[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: FailoverGroup[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: FailoverGroup[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<FailoverGroup>
  • Returns an iterable of values in the array

    Returns IterableIterator<FailoverGroup>

type

type: object

className

className: string = "FailoverGroupListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FailoverGroup"

name

name: "Composite" = "Composite"

Const FailoverGroupReadOnlyEndpoint

FailoverGroupReadOnlyEndpoint: object

Read-only endpoint of the failover group instance.

Optional failoverPolicy

Failover policy of the read-only endpoint for the failover group. Possible values include: 'Disabled', 'Enabled'

serializedName

serializedName: string = "FailoverGroupReadOnlyEndpoint"

type

type: object

className

className: string = "FailoverGroupReadOnlyEndpoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failoverPolicy

failoverPolicy: object

serializedName

serializedName: string = "failoverPolicy"

type

type: object

name

name: "String" = "String"

Const FailoverGroupReadWriteEndpoint

FailoverGroupReadWriteEndpoint: object

Read-write endpoint of the failover group instance.

failoverPolicy

Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. Possible values include: 'Manual', 'Automatic'

Optional failoverWithDataLossGracePeriodMinutes

failoverWithDataLossGracePeriodMinutes: undefined | number

Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

serializedName

serializedName: string = "FailoverGroupReadWriteEndpoint"

type

type: object

className

className: string = "FailoverGroupReadWriteEndpoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failoverPolicy

failoverPolicy: object

required

required: true = true

serializedName

serializedName: string = "failoverPolicy"

type

type: object

name

name: "String" = "String"

failoverWithDataLossGracePeriodMinutes

failoverWithDataLossGracePeriodMinutes: object

serializedName

serializedName: string = "failoverWithDataLossGracePeriodMinutes"

type

type: object

name

name: "Number" = "Number"

Const FailoverGroupUpdate

FailoverGroupUpdate: object

A failover group update request.

Optional databases

databases: string[]

List of databases in the failover group.

Optional readOnlyEndpoint

Read-only endpoint of the failover group instance.

Optional readWriteEndpoint

Read-write endpoint of the failover group instance.

serializedName

serializedName: string = "FailoverGroupUpdate"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "FailoverGroupUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

databases

databases: object

serializedName

serializedName: string = "properties.databases"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

readOnlyEndpoint

readOnlyEndpoint: object

serializedName

serializedName: string = "properties.readOnlyEndpoint"

type

type: object

className

className: string = "FailoverGroupReadOnlyEndpoint"

name

name: "Composite" = "Composite"

readWriteEndpoint

readWriteEndpoint: object

serializedName

serializedName: string = "properties.readWriteEndpoint"

type

type: object

className

className: string = "FailoverGroupReadWriteEndpoint"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const FirewallRule

FirewallRule: object

Represents a server firewall rule.

endIpAddress

endIpAddress: string

The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' to represent all Azure-internal IP addresses.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of server that contains this firewall rule. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

Location of the server that contains this firewall rule. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "FirewallRule"

startIpAddress

startIpAddress: string

The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' to represent all Azure-internal IP addresses.

type

type: object

className

className: string = "FirewallRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endIpAddress

endIpAddress: object

required

required: true = true

serializedName

serializedName: string = "properties.endIpAddress"

type

type: object

name

name: "String" = "String"

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

startIpAddress

startIpAddress: object

required

required: true = true

serializedName

serializedName: string = "properties.startIpAddress"

type

type: object

name

name: "String" = "String"

Const FirewallRuleListResult

FirewallRuleListResult: object
interface

Represents the response to a List Firewall Rules request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "FirewallRuleListResult"

__@iterator

  • __@iterator(): IterableIterator<FirewallRule>
  • Iterator

    Returns IterableIterator<FirewallRule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<FirewallRule>[]): FirewallRule[]
  • concat(...items: (T | ConcatArray<T>)[]): FirewallRule[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<FirewallRule>[]

      Additional items to add to the end of array1.

    Returns FirewallRule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns FirewallRule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, FirewallRule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, FirewallRule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: FirewallRule, index: number, array: FirewallRule[]): boolean
        • Parameters

          • value: FirewallRule
          • index: number
          • array: FirewallRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: FirewallRule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: FirewallRule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): FirewallRule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: FirewallRule

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FirewallRule, index: number, array: FirewallRule[]): boolean
        • Parameters

          • value: FirewallRule
          • index: number
          • array: FirewallRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FirewallRule, index: number, array: FirewallRule[]): any
        • Parameters

          • value: FirewallRule
          • index: number
          • array: FirewallRule[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns FirewallRule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): FirewallRule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: FirewallRule

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: FirewallRule, index: number, obj: FirewallRule[]): boolean
        • Parameters

          • this: void
          • value: FirewallRule
          • index: number
          • obj: FirewallRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: FirewallRule, index: number, obj: FirewallRule[]): boolean
        • Parameters

          • value: FirewallRule
          • index: number
          • obj: FirewallRule[]

          Returns boolean

    • Optional thisArg: any

    Returns FirewallRule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: FirewallRule, index: number, obj: FirewallRule[]): boolean
        • Parameters

          • value: FirewallRule
          • index: number
          • obj: FirewallRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: FirewallRule, index: number, array: FirewallRule[]): void
        • Parameters

          • value: FirewallRule
          • index: number
          • array: FirewallRule[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: FirewallRule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: FirewallRule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: FirewallRule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: FirewallRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: FirewallRule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: FirewallRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: FirewallRule, index: number, array: FirewallRule[]): U
        • Parameters

          • value: FirewallRule
          • index: number
          • array: FirewallRule[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): FirewallRule | undefined
  • Removes the last element from an array and returns it.

    Returns FirewallRule | undefined

push

  • push(...items: FirewallRule[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: FirewallRule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): FirewallRule
  • reduce(callbackfn: function, initialValue: FirewallRule): FirewallRule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: FirewallRule, currentValue: FirewallRule, currentIndex: number, array: FirewallRule[]): FirewallRule
        • Parameters

          • previousValue: FirewallRule
          • currentValue: FirewallRule
          • currentIndex: number
          • array: FirewallRule[]

          Returns FirewallRule

    Returns FirewallRule

  • Parameters

    • callbackfn: function
        • (previousValue: FirewallRule, currentValue: FirewallRule, currentIndex: number, array: FirewallRule[]): FirewallRule
        • Parameters

          • previousValue: FirewallRule
          • currentValue: FirewallRule
          • currentIndex: number
          • array: FirewallRule[]

          Returns FirewallRule

    • initialValue: FirewallRule

    Returns FirewallRule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FirewallRule, currentIndex: number, array: FirewallRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: FirewallRule
          • currentIndex: number
          • array: FirewallRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): FirewallRule
  • reduceRight(callbackfn: function, initialValue: FirewallRule): FirewallRule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: FirewallRule, currentValue: FirewallRule, currentIndex: number, array: FirewallRule[]): FirewallRule
        • Parameters

          • previousValue: FirewallRule
          • currentValue: FirewallRule
          • currentIndex: number
          • array: FirewallRule[]

          Returns FirewallRule

    Returns FirewallRule

  • Parameters

    • callbackfn: function
        • (previousValue: FirewallRule, currentValue: FirewallRule, currentIndex: number, array: FirewallRule[]): FirewallRule
        • Parameters

          • previousValue: FirewallRule
          • currentValue: FirewallRule
          • currentIndex: number
          • array: FirewallRule[]

          Returns FirewallRule

    • initialValue: FirewallRule

    Returns FirewallRule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FirewallRule, currentIndex: number, array: FirewallRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: FirewallRule
          • currentIndex: number
          • array: FirewallRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): FirewallRule[]
  • Reverses the elements in an Array.

    Returns FirewallRule[]

shift

  • shift(): FirewallRule | undefined
  • Removes the first element from an array and returns it.

    Returns FirewallRule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): FirewallRule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns FirewallRule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: FirewallRule, index: number, array: FirewallRule[]): boolean
        • Parameters

          • value: FirewallRule
          • index: number
          • array: FirewallRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): FirewallRule[]
  • splice(start: number, deleteCount: number, ...items: FirewallRule[]): FirewallRule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns FirewallRule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: FirewallRule[]

      Elements to insert into the array in place of the deleted elements.

    Returns FirewallRule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: FirewallRule[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: FirewallRule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<FirewallRule>
  • Returns an iterable of values in the array

    Returns IterableIterator<FirewallRule>

type

type: object

className

className: string = "FirewallRuleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FirewallRule"

name

name: "Composite" = "Composite"

Const GeoBackupPolicy

GeoBackupPolicy: object

A database geo backup policy.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of geo backup policy. This is metadata used for the Azure portal experience. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

Backup policy location. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "GeoBackupPolicy"

state

The state of the geo backup policy. Possible values include: 'Disabled', 'Enabled'

Optional storageType

storageType: undefined | string

The storage type of the geo backup policy. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "GeoBackupPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

state

state: object

required

required: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["Disabled","Enabled"]

name

name: "Enum" = "Enum"

storageType

storageType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.storageType"

type

type: object

name

name: "String" = "String"

Const GeoBackupPolicyListResult

GeoBackupPolicyListResult: object
interface

The response to a list geo backup policies request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "GeoBackupPolicyListResult"

__@iterator

  • __@iterator(): IterableIterator<GeoBackupPolicy>
  • Iterator

    Returns IterableIterator<GeoBackupPolicy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<GeoBackupPolicy>[]): GeoBackupPolicy[]
  • concat(...items: (T | ConcatArray<T>)[]): GeoBackupPolicy[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<GeoBackupPolicy>[]

      Additional items to add to the end of array1.

    Returns GeoBackupPolicy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns GeoBackupPolicy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, GeoBackupPolicy]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, GeoBackupPolicy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: GeoBackupPolicy, index: number, array: GeoBackupPolicy[]): boolean
        • Parameters

          • value: GeoBackupPolicy
          • index: number
          • array: GeoBackupPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: GeoBackupPolicy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: GeoBackupPolicy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): GeoBackupPolicy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: GeoBackupPolicy

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: GeoBackupPolicy, index: number, array: GeoBackupPolicy[]): boolean
        • Parameters

          • value: GeoBackupPolicy
          • index: number
          • array: GeoBackupPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: GeoBackupPolicy, index: number, array: GeoBackupPolicy[]): any
        • Parameters

          • value: GeoBackupPolicy
          • index: number
          • array: GeoBackupPolicy[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns GeoBackupPolicy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): GeoBackupPolicy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: GeoBackupPolicy

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: GeoBackupPolicy, index: number, obj: GeoBackupPolicy[]): boolean
        • Parameters

          • this: void
          • value: GeoBackupPolicy
          • index: number
          • obj: GeoBackupPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: GeoBackupPolicy, index: number, obj: GeoBackupPolicy[]): boolean
        • Parameters

          • value: GeoBackupPolicy
          • index: number
          • obj: GeoBackupPolicy[]

          Returns boolean

    • Optional thisArg: any

    Returns GeoBackupPolicy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: GeoBackupPolicy, index: number, obj: GeoBackupPolicy[]): boolean
        • Parameters

          • value: GeoBackupPolicy
          • index: number
          • obj: GeoBackupPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: GeoBackupPolicy, index: number, array: GeoBackupPolicy[]): void
        • Parameters

          • value: GeoBackupPolicy
          • index: number
          • array: GeoBackupPolicy[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: GeoBackupPolicy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: GeoBackupPolicy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: GeoBackupPolicy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: GeoBackupPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: GeoBackupPolicy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: GeoBackupPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: GeoBackupPolicy, index: number, array: GeoBackupPolicy[]): U
        • Parameters

          • value: GeoBackupPolicy
          • index: number
          • array: GeoBackupPolicy[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): GeoBackupPolicy | undefined
  • Removes the last element from an array and returns it.

    Returns GeoBackupPolicy | undefined

push

  • push(...items: GeoBackupPolicy[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: GeoBackupPolicy[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): GeoBackupPolicy
  • reduce(callbackfn: function, initialValue: GeoBackupPolicy): GeoBackupPolicy
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: GeoBackupPolicy, currentValue: GeoBackupPolicy, currentIndex: number, array: GeoBackupPolicy[]): GeoBackupPolicy
        • Parameters

          • previousValue: GeoBackupPolicy
          • currentValue: GeoBackupPolicy
          • currentIndex: number
          • array: GeoBackupPolicy[]

          Returns GeoBackupPolicy

    Returns GeoBackupPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: GeoBackupPolicy, currentValue: GeoBackupPolicy, currentIndex: number, array: GeoBackupPolicy[]): GeoBackupPolicy
        • Parameters

          • previousValue: GeoBackupPolicy
          • currentValue: GeoBackupPolicy
          • currentIndex: number
          • array: GeoBackupPolicy[]

          Returns GeoBackupPolicy

    • initialValue: GeoBackupPolicy

    Returns GeoBackupPolicy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: GeoBackupPolicy, currentIndex: number, array: GeoBackupPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: GeoBackupPolicy
          • currentIndex: number
          • array: GeoBackupPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): GeoBackupPolicy
  • reduceRight(callbackfn: function, initialValue: GeoBackupPolicy): GeoBackupPolicy
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: GeoBackupPolicy, currentValue: GeoBackupPolicy, currentIndex: number, array: GeoBackupPolicy[]): GeoBackupPolicy
        • Parameters

          • previousValue: GeoBackupPolicy
          • currentValue: GeoBackupPolicy
          • currentIndex: number
          • array: GeoBackupPolicy[]

          Returns GeoBackupPolicy

    Returns GeoBackupPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: GeoBackupPolicy, currentValue: GeoBackupPolicy, currentIndex: number, array: GeoBackupPolicy[]): GeoBackupPolicy
        • Parameters

          • previousValue: GeoBackupPolicy
          • currentValue: GeoBackupPolicy
          • currentIndex: number
          • array: GeoBackupPolicy[]

          Returns GeoBackupPolicy

    • initialValue: GeoBackupPolicy

    Returns GeoBackupPolicy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: GeoBackupPolicy, currentIndex: number, array: GeoBackupPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: GeoBackupPolicy
          • currentIndex: number
          • array: GeoBackupPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): GeoBackupPolicy[]
  • Reverses the elements in an Array.

    Returns GeoBackupPolicy[]

shift

  • shift(): GeoBackupPolicy | undefined
  • Removes the first element from an array and returns it.

    Returns GeoBackupPolicy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): GeoBackupPolicy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns GeoBackupPolicy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: GeoBackupPolicy, index: number, array: GeoBackupPolicy[]): boolean
        • Parameters

          • value: GeoBackupPolicy
          • index: number
          • array: GeoBackupPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): GeoBackupPolicy[]
  • splice(start: number, deleteCount: number, ...items: GeoBackupPolicy[]): GeoBackupPolicy[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns GeoBackupPolicy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: GeoBackupPolicy[]

      Elements to insert into the array in place of the deleted elements.

    Returns GeoBackupPolicy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: GeoBackupPolicy[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: GeoBackupPolicy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<GeoBackupPolicy>
  • Returns an iterable of values in the array

    Returns IterableIterator<GeoBackupPolicy>

type

type: object

className

className: string = "GeoBackupPolicyListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "GeoBackupPolicy"

name

name: "Composite" = "Composite"

Const ImportExportResponse

ImportExportResponse: object

Response for Import/Export Get operation.

Optional blobUri

blobUri: undefined | string

The blob uri. NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseName

databaseName: undefined | string

The name of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorMessage

errorMessage: undefined | string

The error message returned from the server. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedTime

lastModifiedTime: undefined | string

The operation status last modified time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional queuedTime

queuedTime: undefined | string

The operation queued time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestId

requestId: undefined | string

The request type of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestType

requestType: undefined | string

The request type of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ImportExportResponse"

Optional serverName

serverName: undefined | string

The name of the server. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: undefined | string

The status message returned from the server. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ImportExportResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobUri

blobUri: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.blobUri"

type

type: object

name

name: "String" = "String"

databaseName

databaseName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseName"

type

type: object

name

name: "String" = "String"

errorMessage

errorMessage: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errorMessage"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "String" = "String"

queuedTime

queuedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.queuedTime"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestId"

type

type: object

name

name: "Uuid" = "Uuid"

requestType

requestType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.requestType"

type

type: object

name

name: "String" = "String"

serverName

serverName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serverName"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

Const ImportExtensionRequest

ImportExtensionRequest: object

Import database parameters.

administratorLogin

administratorLogin: string

The name of the SQL administrator.

administratorLoginPassword

administratorLoginPassword: string

The password of the SQL administrator.

Optional authenticationType

authenticationType: AuthenticationType

The authentication type. Possible values include: 'SQL', 'ADPassword'. Default value: 'SQL'.

Optional name

name: undefined | string

The name of the extension.

serializedName

serializedName: string = "ImportExtensionRequest"

storageKey

storageKey: string

The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a "?."

storageKeyType

storageKeyType: StorageKeyType

The type of the storage key to use. Possible values include: 'StorageAccessKey', 'SharedAccessKey'

storageUri

storageUri: string

The storage uri to use.

type

type: object

The type of the extension.

className

className: string = "ImportExtensionRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

administratorLogin

administratorLogin: object

required

required: true = true

serializedName

serializedName: string = "properties.administratorLogin"

type

type: object

name

name: "String" = "String"

administratorLoginPassword

administratorLoginPassword: object

required

required: true = true

serializedName

serializedName: string = "properties.administratorLoginPassword"

type

type: object

name

name: "String" = "String"

authenticationType

authenticationType: object

defaultValue

defaultValue: string = "SQL"

serializedName

serializedName: string = "properties.authenticationType"

type

type: object

allowedValues

allowedValues: string[] = ["SQL","ADPassword"]

name

name: "Enum" = "Enum"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

operationMode

operationMode: object

defaultValue

defaultValue: string = "Import"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "properties.operationMode"

type

type: object

name

name: "String" = "String"

storageKey

storageKey: object

required

required: true = true

serializedName

serializedName: string = "properties.storageKey"

type

type: object

name

name: "String" = "String"

storageKeyType

storageKeyType: object

required

required: true = true

serializedName

serializedName: string = "properties.storageKeyType"

type

type: object

allowedValues

allowedValues: string[] = ["StorageAccessKey","SharedAccessKey"]

name

name: "Enum" = "Enum"

storageUri

storageUri: object

required

required: true = true

serializedName

serializedName: string = "properties.storageUri"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ImportRequest

ImportRequest: object

Import database parameters.

administratorLogin

administratorLogin: string

The name of the SQL administrator.

administratorLoginPassword

administratorLoginPassword: string

The password of the SQL administrator.

Optional authenticationType

authenticationType: AuthenticationType

The authentication type. Possible values include: 'SQL', 'ADPassword'. Default value: 'SQL'.

databaseName

databaseName: string

The name of the database to import.

edition

The edition for the database being created. Possible values include: 'Web', 'Business', 'Basic', 'Standard', 'Premium', 'PremiumRS', 'Free', 'Stretch', 'DataWarehouse', 'System', 'System2'

maxSizeBytes

maxSizeBytes: string

The maximum size for the newly imported database.

serializedName

serializedName: string = "ImportRequest"

serviceObjectiveName

serviceObjectiveName: ServiceObjectiveName

The name of the service objective to assign to the database. Possible values include: 'System', 'System0', 'System1', 'System2', 'System3', 'System4', 'System2L', 'System3L', 'System4L', 'Free', 'Basic', 'S0', 'S1', 'S2', 'S3', 'S4', 'S6', 'S7', 'S9', 'S12', 'P1', 'P2', 'P3', 'P4', 'P6', 'P11', 'P15', 'PRS1', 'PRS2', 'PRS4', 'PRS6', 'DW100', 'DW200', 'DW300', 'DW400', 'DW500', 'DW600', 'DW1000', 'DW1200', 'DW1000c', 'DW1500', 'DW1500c', 'DW2000', 'DW2000c', 'DW3000', 'DW2500c', 'DW3000c', 'DW6000', 'DW5000c', 'DW6000c', 'DW7500c', 'DW10000c', 'DW15000c', 'DW30000c', 'DS100', 'DS200', 'DS300', 'DS400', 'DS500', 'DS600', 'DS1000', 'DS1200', 'DS1500', 'DS2000', 'ElasticPool'

storageKey

storageKey: string

The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a "?."

storageKeyType

storageKeyType: StorageKeyType

The type of the storage key to use. Possible values include: 'StorageAccessKey', 'SharedAccessKey'

storageUri

storageUri: string

The storage uri to use.

type

type: object

className

className: string = "ImportRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

databaseName

databaseName: object

required

required: true = true

serializedName

serializedName: string = "databaseName"

type

type: object

name

name: "String" = "String"

edition

edition: object

required

required: true = true

serializedName

serializedName: string = "edition"

type

type: object

name

name: "String" = "String"

maxSizeBytes

maxSizeBytes: object

required

required: true = true

serializedName

serializedName: string = "maxSizeBytes"

type

type: object

name

name: "String" = "String"

serviceObjectiveName

serviceObjectiveName: object

required

required: true = true

serializedName

serializedName: string = "serviceObjectiveName"

type

type: object

name

name: "String" = "String"

Const InstanceFailoverGroup

InstanceFailoverGroup: object

An instance failover group.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

managedInstancePairs

managedInstancePairs: ManagedInstancePairInfo[]

List of managed instance pairs in the failover group.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

partnerRegions

partnerRegions: PartnerRegionInfo[]

Partner region information for the failover group.

Optional readOnlyEndpoint

Read-only endpoint of the failover group instance.

readWriteEndpoint

readWriteEndpoint: InstanceFailoverGroupReadWriteEndpoint

Read-write endpoint of the failover group instance.

Optional replicationRole

Local replication role of the failover group instance. Possible values include: 'Primary', 'Secondary' NOTE: This property will not be serialized. It can only be populated by the server.

Optional replicationState

replicationState: undefined | string

Replication state of the failover group instance. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "InstanceFailoverGroup"

type

type: object

className

className: string = "InstanceFailoverGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

managedInstancePairs

managedInstancePairs: object

required

required: true = true

serializedName

serializedName: string = "properties.managedInstancePairs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedInstancePairInfo"

name

name: "Composite" = "Composite"

partnerRegions

partnerRegions: object

required

required: true = true

serializedName

serializedName: string = "properties.partnerRegions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PartnerRegionInfo"

name

name: "Composite" = "Composite"

readOnlyEndpoint

readOnlyEndpoint: object

serializedName

serializedName: string = "properties.readOnlyEndpoint"

type

type: object

className

className: string = "InstanceFailoverGroupReadOnlyEndpoint"

name

name: "Composite" = "Composite"

readWriteEndpoint

readWriteEndpoint: object

required

required: true = true

serializedName

serializedName: string = "properties.readWriteEndpoint"

type

type: object

className

className: string = "InstanceFailoverGroupReadWriteEndpoint"

name

name: "Composite" = "Composite"

replicationRole

replicationRole: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.replicationRole"

type

type: object

name

name: "String" = "String"

replicationState

replicationState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.replicationState"

type

type: object

name

name: "String" = "String"

Const InstanceFailoverGroupListResult

InstanceFailoverGroupListResult: object
interface

A list of instance failover groups.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "InstanceFailoverGroupListResult"

__@iterator

  • __@iterator(): IterableIterator<InstanceFailoverGroup>
  • Iterator

    Returns IterableIterator<InstanceFailoverGroup>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<InstanceFailoverGroup>[]): InstanceFailoverGroup[]
  • concat(...items: (T | ConcatArray<T>)[]): InstanceFailoverGroup[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<InstanceFailoverGroup>[]

      Additional items to add to the end of array1.

    Returns InstanceFailoverGroup[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns InstanceFailoverGroup[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, InstanceFailoverGroup]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, InstanceFailoverGroup]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: InstanceFailoverGroup, index: number, array: InstanceFailoverGroup[]): boolean
        • Parameters

          • value: InstanceFailoverGroup
          • index: number
          • array: InstanceFailoverGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: InstanceFailoverGroup, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: InstanceFailoverGroup

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): InstanceFailoverGroup[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: InstanceFailoverGroup

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: InstanceFailoverGroup, index: number, array: InstanceFailoverGroup[]): boolean
        • Parameters

          • value: InstanceFailoverGroup
          • index: number
          • array: InstanceFailoverGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: InstanceFailoverGroup, index: number, array: InstanceFailoverGroup[]): any
        • Parameters

          • value: InstanceFailoverGroup
          • index: number
          • array: InstanceFailoverGroup[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns InstanceFailoverGroup[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): InstanceFailoverGroup | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: InstanceFailoverGroup

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: InstanceFailoverGroup, index: number, obj: InstanceFailoverGroup[]): boolean
        • Parameters

          • this: void
          • value: InstanceFailoverGroup
          • index: number
          • obj: InstanceFailoverGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: InstanceFailoverGroup, index: number, obj: InstanceFailoverGroup[]): boolean
        • Parameters

          • value: InstanceFailoverGroup
          • index: number
          • obj: InstanceFailoverGroup[]

          Returns boolean

    • Optional thisArg: any

    Returns InstanceFailoverGroup | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: InstanceFailoverGroup, index: number, obj: InstanceFailoverGroup[]): boolean
        • Parameters

          • value: InstanceFailoverGroup
          • index: number
          • obj: InstanceFailoverGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: InstanceFailoverGroup, index: number, array: InstanceFailoverGroup[]): void
        • Parameters

          • value: InstanceFailoverGroup
          • index: number
          • array: InstanceFailoverGroup[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: InstanceFailoverGroup, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: InstanceFailoverGroup

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: InstanceFailoverGroup, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: InstanceFailoverGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: InstanceFailoverGroup, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: InstanceFailoverGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: InstanceFailoverGroup, index: number, array: InstanceFailoverGroup[]): U
        • Parameters

          • value: InstanceFailoverGroup
          • index: number
          • array: InstanceFailoverGroup[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): InstanceFailoverGroup | undefined
  • Removes the last element from an array and returns it.

    Returns InstanceFailoverGroup | undefined

push

  • push(...items: InstanceFailoverGroup[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: InstanceFailoverGroup[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): InstanceFailoverGroup
  • reduce(callbackfn: function, initialValue: InstanceFailoverGroup): InstanceFailoverGroup
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: InstanceFailoverGroup, currentValue: InstanceFailoverGroup, currentIndex: number, array: InstanceFailoverGroup[]): InstanceFailoverGroup
        • Parameters

          • previousValue: InstanceFailoverGroup
          • currentValue: InstanceFailoverGroup
          • currentIndex: number
          • array: InstanceFailoverGroup[]

          Returns InstanceFailoverGroup

    Returns InstanceFailoverGroup

  • Parameters

    • callbackfn: function
        • (previousValue: InstanceFailoverGroup, currentValue: InstanceFailoverGroup, currentIndex: number, array: InstanceFailoverGroup[]): InstanceFailoverGroup
        • Parameters

          • previousValue: InstanceFailoverGroup
          • currentValue: InstanceFailoverGroup
          • currentIndex: number
          • array: InstanceFailoverGroup[]

          Returns InstanceFailoverGroup

    • initialValue: InstanceFailoverGroup

    Returns InstanceFailoverGroup

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: InstanceFailoverGroup, currentIndex: number, array: InstanceFailoverGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: InstanceFailoverGroup
          • currentIndex: number
          • array: InstanceFailoverGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): InstanceFailoverGroup
  • reduceRight(callbackfn: function, initialValue: InstanceFailoverGroup): InstanceFailoverGroup
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: InstanceFailoverGroup, currentValue: InstanceFailoverGroup, currentIndex: number, array: InstanceFailoverGroup[]): InstanceFailoverGroup
        • Parameters

          • previousValue: InstanceFailoverGroup
          • currentValue: InstanceFailoverGroup
          • currentIndex: number
          • array: InstanceFailoverGroup[]

          Returns InstanceFailoverGroup

    Returns InstanceFailoverGroup

  • Parameters

    • callbackfn: function
        • (previousValue: InstanceFailoverGroup, currentValue: InstanceFailoverGroup, currentIndex: number, array: InstanceFailoverGroup[]): InstanceFailoverGroup
        • Parameters

          • previousValue: InstanceFailoverGroup
          • currentValue: InstanceFailoverGroup
          • currentIndex: number
          • array: InstanceFailoverGroup[]

          Returns InstanceFailoverGroup

    • initialValue: InstanceFailoverGroup

    Returns InstanceFailoverGroup

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: InstanceFailoverGroup, currentIndex: number, array: InstanceFailoverGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: InstanceFailoverGroup
          • currentIndex: number
          • array: InstanceFailoverGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): InstanceFailoverGroup[]
  • Reverses the elements in an Array.

    Returns InstanceFailoverGroup[]

shift

  • shift(): InstanceFailoverGroup | undefined
  • Removes the first element from an array and returns it.

    Returns InstanceFailoverGroup | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): InstanceFailoverGroup[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns InstanceFailoverGroup[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: InstanceFailoverGroup, index: number, array: InstanceFailoverGroup[]): boolean
        • Parameters

          • value: InstanceFailoverGroup
          • index: number
          • array: InstanceFailoverGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): InstanceFailoverGroup[]
  • splice(start: number, deleteCount: number, ...items: InstanceFailoverGroup[]): InstanceFailoverGroup[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns InstanceFailoverGroup[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: InstanceFailoverGroup[]

      Elements to insert into the array in place of the deleted elements.

    Returns InstanceFailoverGroup[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: InstanceFailoverGroup[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: InstanceFailoverGroup[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<InstanceFailoverGroup>
  • Returns an iterable of values in the array

    Returns IterableIterator<InstanceFailoverGroup>

type

type: object

className

className: string = "InstanceFailoverGroupListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InstanceFailoverGroup"

name

name: "Composite" = "Composite"

Const InstanceFailoverGroupReadOnlyEndpoint

InstanceFailoverGroupReadOnlyEndpoint: object

Read-only endpoint of the failover group instance.

Optional failoverPolicy

Failover policy of the read-only endpoint for the failover group. Possible values include: 'Disabled', 'Enabled'

serializedName

serializedName: string = "InstanceFailoverGroupReadOnlyEndpoint"

type

type: object

className

className: string = "InstanceFailoverGroupReadOnlyEndpoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failoverPolicy

failoverPolicy: object

serializedName

serializedName: string = "failoverPolicy"

type

type: object

name

name: "String" = "String"

Const InstanceFailoverGroupReadWriteEndpoint

InstanceFailoverGroupReadWriteEndpoint: object

Read-write endpoint of the failover group instance.

failoverPolicy

Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. Possible values include: 'Manual', 'Automatic'

Optional failoverWithDataLossGracePeriodMinutes

failoverWithDataLossGracePeriodMinutes: undefined | number

Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

serializedName

serializedName: string = "InstanceFailoverGroupReadWriteEndpoint"

type

type: object

className

className: string = "InstanceFailoverGroupReadWriteEndpoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failoverPolicy

failoverPolicy: object

required

required: true = true

serializedName

serializedName: string = "failoverPolicy"

type

type: object

name

name: "String" = "String"

failoverWithDataLossGracePeriodMinutes

failoverWithDataLossGracePeriodMinutes: object

serializedName

serializedName: string = "failoverWithDataLossGracePeriodMinutes"

type

type: object

name

name: "Number" = "Number"

Const Job

Job: object

A job.

Optional description

description: undefined | string

User-defined description of the job. Default value: ''.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional schedule

schedule: JobSchedule

Schedule properties of the job.

serializedName

serializedName: string = "Job"

Optional version

version: undefined | number

The job version number. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "Job"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

defaultValue

defaultValue: string = ""

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

schedule

schedule: object

serializedName

serializedName: string = "properties.schedule"

type

type: object

className

className: string = "JobSchedule"

name

name: "Composite" = "Composite"

version

version: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.version"

type

type: object

name

name: "Number" = "Number"

Const JobAgent

JobAgent: object

An Azure SQL job agent.

databaseId

databaseId: string

Resource ID of the database to store job metadata in.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobAgent"

Optional sku

sku: Sku

The name and tier of the SKU.

Optional state

The state of the job agent. Possible values include: 'Creating', 'Ready', 'Updating', 'Deleting', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "JobAgent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

databaseId

databaseId: object

required

required: true = true

serializedName

serializedName: string = "properties.databaseId"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const JobAgentListResult

JobAgentListResult: object
interface

A list of Azure SQL job agents.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobAgentListResult"

__@iterator

  • __@iterator(): IterableIterator<JobAgent>
  • Iterator

    Returns IterableIterator<JobAgent>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<JobAgent>[]): JobAgent[]
  • concat(...items: (T | ConcatArray<T>)[]): JobAgent[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<JobAgent>[]

      Additional items to add to the end of array1.

    Returns JobAgent[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns JobAgent[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, JobAgent]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, JobAgent]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: JobAgent, index: number, array: JobAgent[]): boolean
        • Parameters

          • value: JobAgent
          • index: number
          • array: JobAgent[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: JobAgent, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: JobAgent

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): JobAgent[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: JobAgent

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobAgent, index: number, array: JobAgent[]): boolean
        • Parameters

          • value: JobAgent
          • index: number
          • array: JobAgent[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobAgent, index: number, array: JobAgent[]): any
        • Parameters

          • value: JobAgent
          • index: number
          • array: JobAgent[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns JobAgent[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): JobAgent | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: JobAgent

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: JobAgent, index: number, obj: JobAgent[]): boolean
        • Parameters

          • this: void
          • value: JobAgent
          • index: number
          • obj: JobAgent[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: JobAgent, index: number, obj: JobAgent[]): boolean
        • Parameters

          • value: JobAgent
          • index: number
          • obj: JobAgent[]

          Returns boolean

    • Optional thisArg: any

    Returns JobAgent | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: JobAgent, index: number, obj: JobAgent[]): boolean
        • Parameters

          • value: JobAgent
          • index: number
          • obj: JobAgent[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: JobAgent, index: number, array: JobAgent[]): void
        • Parameters

          • value: JobAgent
          • index: number
          • array: JobAgent[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: JobAgent, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: JobAgent

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: JobAgent, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: JobAgent

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: JobAgent, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: JobAgent

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: JobAgent, index: number, array: JobAgent[]): U
        • Parameters

          • value: JobAgent
          • index: number
          • array: JobAgent[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): JobAgent | undefined
  • Removes the last element from an array and returns it.

    Returns JobAgent | undefined

push

  • push(...items: JobAgent[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: JobAgent[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): JobAgent
  • reduce(callbackfn: function, initialValue: JobAgent): JobAgent
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobAgent, currentValue: JobAgent, currentIndex: number, array: JobAgent[]): JobAgent
        • Parameters

          • previousValue: JobAgent
          • currentValue: JobAgent
          • currentIndex: number
          • array: JobAgent[]

          Returns JobAgent

    Returns JobAgent

  • Parameters

    • callbackfn: function
        • (previousValue: JobAgent, currentValue: JobAgent, currentIndex: number, array: JobAgent[]): JobAgent
        • Parameters

          • previousValue: JobAgent
          • currentValue: JobAgent
          • currentIndex: number
          • array: JobAgent[]

          Returns JobAgent

    • initialValue: JobAgent

    Returns JobAgent

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobAgent, currentIndex: number, array: JobAgent[]): U
        • Parameters

          • previousValue: U
          • currentValue: JobAgent
          • currentIndex: number
          • array: JobAgent[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): JobAgent
  • reduceRight(callbackfn: function, initialValue: JobAgent): JobAgent
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobAgent, currentValue: JobAgent, currentIndex: number, array: JobAgent[]): JobAgent
        • Parameters

          • previousValue: JobAgent
          • currentValue: JobAgent
          • currentIndex: number
          • array: JobAgent[]

          Returns JobAgent

    Returns JobAgent

  • Parameters

    • callbackfn: function
        • (previousValue: JobAgent, currentValue: JobAgent, currentIndex: number, array: JobAgent[]): JobAgent
        • Parameters

          • previousValue: JobAgent
          • currentValue: JobAgent
          • currentIndex: number
          • array: JobAgent[]

          Returns JobAgent

    • initialValue: JobAgent

    Returns JobAgent

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobAgent, currentIndex: number, array: JobAgent[]): U
        • Parameters

          • previousValue: U
          • currentValue: JobAgent
          • currentIndex: number
          • array: JobAgent[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): JobAgent[]
  • Reverses the elements in an Array.

    Returns JobAgent[]

shift

  • shift(): JobAgent | undefined
  • Removes the first element from an array and returns it.

    Returns JobAgent | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): JobAgent[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns JobAgent[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: JobAgent, index: number, array: JobAgent[]): boolean
        • Parameters

          • value: JobAgent
          • index: number
          • array: JobAgent[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): JobAgent[]
  • splice(start: number, deleteCount: number, ...items: JobAgent[]): JobAgent[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns JobAgent[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: JobAgent[]

      Elements to insert into the array in place of the deleted elements.

    Returns JobAgent[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: JobAgent[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: JobAgent[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<JobAgent>
  • Returns an iterable of values in the array

    Returns IterableIterator<JobAgent>

type

type: object

className

className: string = "JobAgentListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobAgent"

name

name: "Composite" = "Composite"

Const JobAgentUpdate

JobAgentUpdate: object

An update to an Azure SQL job agent.

serializedName

serializedName: string = "JobAgentUpdate"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "JobAgentUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const JobCredential

JobCredential: object

A stored credential that can be used by a job to connect to target databases.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

password

password: string

The credential password.

serializedName

serializedName: string = "JobCredential"

username

username: string

The credential user name.

type

type: object

className

className: string = "JobCredential"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

password

password: object

required

required: true = true

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

username

username: object

required

required: true = true

serializedName

serializedName: string = "properties.username"

type

type: object

name

name: "String" = "String"

Const JobCredentialListResult

JobCredentialListResult: object
interface

A list of job credentials.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobCredentialListResult"

__@iterator

  • __@iterator(): IterableIterator<JobCredential>
  • Iterator

    Returns IterableIterator<JobCredential>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<JobCredential>[]): JobCredential[]
  • concat(...items: (T | ConcatArray<T>)[]): JobCredential[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<JobCredential>[]

      Additional items to add to the end of array1.

    Returns JobCredential[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns JobCredential[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, JobCredential]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, JobCredential]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: JobCredential, index: number, array: JobCredential[]): boolean
        • Parameters

          • value: JobCredential
          • index: number
          • array: JobCredential[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: JobCredential, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: JobCredential

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): JobCredential[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: JobCredential

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobCredential, index: number, array: JobCredential[]): boolean
        • Parameters

          • value: JobCredential
          • index: number
          • array: JobCredential[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobCredential, index: number, array: JobCredential[]): any
        • Parameters

          • value: JobCredential
          • index: number
          • array: JobCredential[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns JobCredential[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): JobCredential | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: JobCredential

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: JobCredential, index: number, obj: JobCredential[]): boolean
        • Parameters

          • this: void
          • value: JobCredential
          • index: number
          • obj: JobCredential[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: JobCredential, index: number, obj: JobCredential[]): boolean
        • Parameters

          • value: JobCredential
          • index: number
          • obj: JobCredential[]

          Returns boolean

    • Optional thisArg: any

    Returns JobCredential | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: JobCredential, index: number, obj: JobCredential[]): boolean
        • Parameters

          • value: JobCredential
          • index: number
          • obj: JobCredential[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: JobCredential, index: number, array: JobCredential[]): void
        • Parameters

          • value: JobCredential
          • index: number
          • array: JobCredential[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: JobCredential, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: JobCredential

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: JobCredential, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: JobCredential

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: JobCredential, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: JobCredential

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: JobCredential, index: number, array: JobCredential[]): U
        • Parameters

          • value: JobCredential
          • index: number
          • array: JobCredential[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): JobCredential | undefined
  • Removes the last element from an array and returns it.

    Returns JobCredential | undefined

push

  • push(...items: JobCredential[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: JobCredential[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): JobCredential
  • reduce(callbackfn: function, initialValue: JobCredential): JobCredential
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobCredential, currentValue: JobCredential, currentIndex: number, array: JobCredential[]): JobCredential
        • Parameters

          • previousValue: JobCredential
          • currentValue: JobCredential
          • currentIndex: number
          • array: JobCredential[]

          Returns JobCredential

    Returns JobCredential

  • Parameters

    • callbackfn: function
        • (previousValue: JobCredential, currentValue: JobCredential, currentIndex: number, array: JobCredential[]): JobCredential
        • Parameters

          • previousValue: JobCredential
          • currentValue: JobCredential
          • currentIndex: number
          • array: JobCredential[]

          Returns JobCredential

    • initialValue: JobCredential

    Returns JobCredential

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobCredential, currentIndex: number, array: JobCredential[]): U
        • Parameters

          • previousValue: U
          • currentValue: JobCredential
          • currentIndex: number
          • array: JobCredential[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): JobCredential
  • reduceRight(callbackfn: function, initialValue: JobCredential): JobCredential
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobCredential, currentValue: JobCredential, currentIndex: number, array: JobCredential[]): JobCredential
        • Parameters

          • previousValue: JobCredential
          • currentValue: JobCredential
          • currentIndex: number
          • array: JobCredential[]

          Returns JobCredential

    Returns JobCredential

  • Parameters

    • callbackfn: function
        • (previousValue: JobCredential, currentValue: JobCredential, currentIndex: number, array: JobCredential[]): JobCredential
        • Parameters

          • previousValue: JobCredential
          • currentValue: JobCredential
          • currentIndex: number
          • array: JobCredential[]

          Returns JobCredential

    • initialValue: JobCredential

    Returns JobCredential

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobCredential, currentIndex: number, array: JobCredential[]): U
        • Parameters

          • previousValue: U
          • currentValue: JobCredential
          • currentIndex: number
          • array: JobCredential[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): JobCredential[]
  • Reverses the elements in an Array.

    Returns JobCredential[]

shift

  • shift(): JobCredential | undefined
  • Removes the first element from an array and returns it.

    Returns JobCredential | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): JobCredential[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns JobCredential[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: JobCredential, index: number, array: JobCredential[]): boolean
        • Parameters

          • value: JobCredential
          • index: number
          • array: JobCredential[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): JobCredential[]
  • splice(start: number, deleteCount: number, ...items: JobCredential[]): JobCredential[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns JobCredential[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: JobCredential[]

      Elements to insert into the array in place of the deleted elements.

    Returns JobCredential[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: JobCredential[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: JobCredential[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<JobCredential>
  • Returns an iterable of values in the array

    Returns IterableIterator<JobCredential>

type

type: object

className

className: string = "JobCredentialListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobCredential"

name

name: "Composite" = "Composite"

Const JobExecution

JobExecution: object

An execution of a job

Optional createTime

createTime: Date

The time that the job execution was created. NOTE: This property will not be serialized. It can only be populated by the server.

Optional currentAttemptStartTime

currentAttemptStartTime: Date

Start time of the current attempt. NOTE: This property will not be serialized. It can only be populated by the server.

Optional currentAttempts

currentAttempts: undefined | number

Number of times the job execution has been attempted.

Optional endTime

endTime: Date

The time that the job execution completed. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional jobExecutionId

jobExecutionId: undefined | string

The unique identifier of the job execution. NOTE: This property will not be serialized. It can only be populated by the server.

Optional jobVersion

jobVersion: undefined | number

The job version number. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastMessage

lastMessage: undefined | string

The last status or error message. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lifecycle

The detailed state of the job execution. Possible values include: 'Created', 'InProgress', 'WaitingForChildJobExecutions', 'WaitingForRetry', 'Succeeded', 'SucceededWithSkipped', 'Failed', 'TimedOut', 'Canceled', 'Skipped' NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningState

The ARM provisioning state of the job execution. Possible values include: 'Created', 'InProgress', 'Succeeded', 'Failed', 'Canceled' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobExecution"

Optional startTime

startTime: Date

The time that the job execution started. NOTE: This property will not be serialized. It can only be populated by the server.

Optional stepId

stepId: undefined | number

The job step id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional stepName

stepName: undefined | string

The job step name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional target

The target that this execution is executed on. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "JobExecution"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createTime

createTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createTime"

type

type: object

name

name: "DateTime" = "DateTime"

currentAttemptStartTime

currentAttemptStartTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.currentAttemptStartTime"

type

type: object

name

name: "DateTime" = "DateTime"

currentAttempts

currentAttempts: object

serializedName

serializedName: string = "properties.currentAttempts"

type

type: object

name

name: "Number" = "Number"

endTime

endTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

jobExecutionId

jobExecutionId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.jobExecutionId"

type

type: object

name

name: "Uuid" = "Uuid"

jobVersion

jobVersion: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.jobVersion"

type

type: object

name

name: "Number" = "Number"

lastMessage

lastMessage: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastMessage"

type

type: object

name

name: "String" = "String"

lifecycle

lifecycle: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lifecycle"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

stepId

stepId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.stepId"

type

type: object

name

name: "Number" = "Number"

stepName

stepName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.stepName"

type

type: object

name

name: "String" = "String"

target

target: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.target"

type

type: object

className

className: string = "JobExecutionTarget"

name

name: "Composite" = "Composite"

Const JobExecutionListResult

JobExecutionListResult: object
interface

A list of job executions.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobExecutionListResult"

__@iterator

  • __@iterator(): IterableIterator<JobExecution>
  • Iterator

    Returns IterableIterator<JobExecution>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<JobExecution>[]): JobExecution[]
  • concat(...items: (T | ConcatArray<T>)[]): JobExecution[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<JobExecution>[]

      Additional items to add to the end of array1.

    Returns JobExecution[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns JobExecution[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, JobExecution]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, JobExecution]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: JobExecution, index: number, array: JobExecution[]): boolean
        • Parameters

          • value: JobExecution
          • index: number
          • array: JobExecution[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: JobExecution, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: JobExecution

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): JobExecution[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: JobExecution

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobExecution, index: number, array: JobExecution[]): boolean
        • Parameters

          • value: JobExecution
          • index: number
          • array: JobExecution[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobExecution, index: number, array: JobExecution[]): any
        • Parameters

          • value: JobExecution
          • index: number
          • array: JobExecution[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns JobExecution[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): JobExecution | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: JobExecution

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: JobExecution, index: number, obj: JobExecution[]): boolean
        • Parameters

          • this: void
          • value: JobExecution
          • index: number
          • obj: JobExecution[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: JobExecution, index: number, obj: JobExecution[]): boolean
        • Parameters

          • value: JobExecution
          • index: number
          • obj: JobExecution[]

          Returns boolean

    • Optional thisArg: any

    Returns JobExecution | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: JobExecution, index: number, obj: JobExecution[]): boolean
        • Parameters

          • value: JobExecution
          • index: number
          • obj: JobExecution[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: JobExecution, index: number, array: JobExecution[]): void
        • Parameters

          • value: JobExecution
          • index: number
          • array: JobExecution[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: JobExecution, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: JobExecution

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: JobExecution, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: JobExecution

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: JobExecution, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: JobExecution

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: JobExecution, index: number, array: JobExecution[]): U
        • Parameters

          • value: JobExecution
          • index: number
          • array: JobExecution[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): JobExecution | undefined
  • Removes the last element from an array and returns it.

    Returns JobExecution | undefined

push

  • push(...items: JobExecution[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: JobExecution[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): JobExecution
  • reduce(callbackfn: function, initialValue: JobExecution): JobExecution
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobExecution, currentValue: JobExecution, currentIndex: number, array: JobExecution[]): JobExecution
        • Parameters

          • previousValue: JobExecution
          • currentValue: JobExecution
          • currentIndex: number
          • array: JobExecution[]

          Returns JobExecution

    Returns JobExecution

  • Parameters

    • callbackfn: function
        • (previousValue: JobExecution, currentValue: JobExecution, currentIndex: number, array: JobExecution[]): JobExecution
        • Parameters

          • previousValue: JobExecution
          • currentValue: JobExecution
          • currentIndex: number
          • array: JobExecution[]

          Returns JobExecution

    • initialValue: JobExecution

    Returns JobExecution

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobExecution, currentIndex: number, array: JobExecution[]): U
        • Parameters

          • previousValue: U
          • currentValue: JobExecution
          • currentIndex: number
          • array: JobExecution[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): JobExecution
  • reduceRight(callbackfn: function, initialValue: JobExecution): JobExecution
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobExecution, currentValue: JobExecution, currentIndex: number, array: JobExecution[]): JobExecution
        • Parameters

          • previousValue: JobExecution
          • currentValue: JobExecution
          • currentIndex: number
          • array: JobExecution[]

          Returns JobExecution

    Returns JobExecution

  • Parameters

    • callbackfn: function
        • (previousValue: JobExecution, currentValue: JobExecution, currentIndex: number, array: JobExecution[]): JobExecution
        • Parameters

          • previousValue: JobExecution
          • currentValue: JobExecution
          • currentIndex: number
          • array: JobExecution[]

          Returns JobExecution

    • initialValue: JobExecution

    Returns JobExecution

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobExecution, currentIndex: number, array: JobExecution[]): U
        • Parameters

          • previousValue: U
          • currentValue: JobExecution
          • currentIndex: number
          • array: JobExecution[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): JobExecution[]
  • Reverses the elements in an Array.

    Returns JobExecution[]

shift

  • shift(): JobExecution | undefined
  • Removes the first element from an array and returns it.

    Returns JobExecution | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): JobExecution[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns JobExecution[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: JobExecution, index: number, array: JobExecution[]): boolean
        • Parameters

          • value: JobExecution
          • index: number
          • array: JobExecution[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): JobExecution[]
  • splice(start: number, deleteCount: number, ...items: JobExecution[]): JobExecution[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns JobExecution[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: JobExecution[]

      Elements to insert into the array in place of the deleted elements.

    Returns JobExecution[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: JobExecution[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: JobExecution[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<JobExecution>
  • Returns an iterable of values in the array

    Returns IterableIterator<JobExecution>

type

type: object

className

className: string = "JobExecutionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobExecution"

name

name: "Composite" = "Composite"

Const JobExecutionTarget

JobExecutionTarget: object

The target that a job execution is executed on.

Optional databaseName

databaseName: undefined | string

The database name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobExecutionTarget"

Optional serverName

serverName: undefined | string

The server name. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

The type of the target. Possible values include: 'TargetGroup', 'SqlDatabase', 'SqlElasticPool', 'SqlShardMap', 'SqlServer' NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "JobExecutionTarget"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

databaseName

databaseName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "databaseName"

type

type: object

name

name: "String" = "String"

serverName

serverName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "serverName"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const JobListResult

JobListResult: object
interface

A list of jobs.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobListResult"

__@iterator

  • __@iterator(): IterableIterator<Job>
  • Iterator

    Returns IterableIterator<Job>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Job>[]): Job[]
  • concat(...items: (T | ConcatArray<T>)[]): Job[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Job>[]

      Additional items to add to the end of array1.

    Returns Job[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Job[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Job]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Job]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Job, index: number, array: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Job, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Job

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Job[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Job

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): any
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Job[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Job | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Job

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Job, index: number, obj: Job[]): boolean
        • Parameters

          • this: void
          • value: Job
          • index: number
          • obj: Job[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Job, index: number, obj: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • obj: Job[]

          Returns boolean

    • Optional thisArg: any

    Returns Job | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Job, index: number, obj: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • obj: Job[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): void
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Job, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Job

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Job, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Job

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Job, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Job

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): U
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Job | undefined
  • Removes the last element from an array and returns it.

    Returns Job | undefined

push

  • push(...items: Job[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Job[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Job
  • reduce(callbackfn: function, initialValue: Job): Job
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    Returns Job

  • Parameters

    • callbackfn: function
        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    • initialValue: Job

    Returns Job

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Job, currentIndex: number, array: Job[]): U
        • Parameters

          • previousValue: U
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Job
  • reduceRight(callbackfn: function, initialValue: Job): Job
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    Returns Job

  • Parameters

    • callbackfn: function
        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    • initialValue: Job

    Returns Job

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Job, currentIndex: number, array: Job[]): U
        • Parameters

          • previousValue: U
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Job[]
  • Reverses the elements in an Array.

    Returns Job[]

shift

  • shift(): Job | undefined
  • Removes the first element from an array and returns it.

    Returns Job | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Job[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Job[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Job, index: number, array: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Job[]
  • splice(start: number, deleteCount: number, ...items: Job[]): Job[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Job[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Job[]

      Elements to insert into the array in place of the deleted elements.

    Returns Job[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Job[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Job[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Job>
  • Returns an iterable of values in the array

    Returns IterableIterator<Job>

type

type: object

className

className: string = "JobListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Job"

name

name: "Composite" = "Composite"

Const JobSchedule

JobSchedule: object

Scheduling properties of a job.

Optional enabled

enabled: undefined | false | true

Whether or not the schedule is enabled.

Optional endTime

endTime: Date

Schedule end time. Default value: new Date('9999-12-31T11:59:59Z').

Optional interval

interval: undefined | string

Value of the schedule's recurring interval, if the schedule type is recurring. ISO8601 duration format.

serializedName

serializedName: string = "JobSchedule"

Optional startTime

startTime: Date

Schedule start time. Default value: new Date('0001-01-01T00:00:00Z').

type

type: object

Schedule interval type. Possible values include: 'Once', 'Recurring'. Default value: 'Once'.

className

className: string = "JobSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

endTime

endTime: object

defaultValue

defaultValue: Date = new Date('9999-12-31T11:59:59Z')

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

interval

interval: object

serializedName

serializedName: string = "interval"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

defaultValue

defaultValue: Date = new Date('0001-01-01T00:00:00Z')

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

type

type: object

defaultValue

defaultValue: string = "Once"

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["Once","Recurring"]

name

name: "Enum" = "Enum"

Const JobStep

JobStep: object

A job step.

action

action: JobStepAction

The action payload of the job step.

credential

credential: string

The resource ID of the job credential that will be used to connect to the targets.

Optional executionOptions

executionOptions: JobStepExecutionOptions

Execution options for the job step.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional output

Output destination properties of the job step.

serializedName

serializedName: string = "JobStep"

Optional stepId

stepId: undefined | number

The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.

targetGroup

targetGroup: string

The resource ID of the target group that the job step will be executed on.

type

type: object

className

className: string = "JobStep"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

required

required: true = true

serializedName

serializedName: string = "properties.action"

type

type: object

className

className: string = "JobStepAction"

name

name: "Composite" = "Composite"

credential

credential: object

required

required: true = true

serializedName

serializedName: string = "properties.credential"

type

type: object

name

name: "String" = "String"

executionOptions

executionOptions: object

serializedName

serializedName: string = "properties.executionOptions"

type

type: object

className

className: string = "JobStepExecutionOptions"

name

name: "Composite" = "Composite"

output

output: object

serializedName

serializedName: string = "properties.output"

type

type: object

className

className: string = "JobStepOutput"

name

name: "Composite" = "Composite"

stepId

stepId: object

serializedName

serializedName: string = "properties.stepId"

type

type: object

name

name: "Number" = "Number"

targetGroup

targetGroup: object

required

required: true = true

serializedName

serializedName: string = "properties.targetGroup"

type

type: object

name

name: "String" = "String"

Const JobStepAction

JobStepAction: object

The action to be executed by a job step.

serializedName

serializedName: string = "JobStepAction"

Optional source

The source of the action to execute. Possible values include: 'Inline'. Default value: 'Inline'.

value

value: string

The action value, for example the text of the T-SQL script to execute.

type

type: object

Type of action being executed by the job step. Possible values include: 'TSql'. Default value: 'TSql'.

className

className: string = "JobStepAction"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

source

source: object

defaultValue

defaultValue: string = "Inline"

serializedName

serializedName: string = "source"

type

type: object

name

name: "String" = "String"

type

type: object

defaultValue

defaultValue: string = "TSql"

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const JobStepExecutionOptions

JobStepExecutionOptions: object

The execution options of a job step.

Optional initialRetryIntervalSeconds

initialRetryIntervalSeconds: undefined | number

Initial delay between retries for job step execution. Default value: 1.

Optional maximumRetryIntervalSeconds

maximumRetryIntervalSeconds: undefined | number

The maximum amount of time to wait between retries for job step execution. Default value: 120.

Optional retryAttempts

retryAttempts: undefined | number

Maximum number of times the job step will be reattempted if the first attempt fails. Default value: 10.

Optional retryIntervalBackoffMultiplier

retryIntervalBackoffMultiplier: undefined | number

The backoff multiplier for the time between retries. Default value: 2.

serializedName

serializedName: string = "JobStepExecutionOptions"

Optional timeoutSeconds

timeoutSeconds: undefined | number

Execution timeout for the job step. Default value: 43200.

type

type: object

className

className: string = "JobStepExecutionOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

initialRetryIntervalSeconds

initialRetryIntervalSeconds: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "initialRetryIntervalSeconds"

type

type: object

name

name: "Number" = "Number"

maximumRetryIntervalSeconds

maximumRetryIntervalSeconds: object

defaultValue

defaultValue: number = 120

serializedName

serializedName: string = "maximumRetryIntervalSeconds"

type

type: object

name

name: "Number" = "Number"

retryAttempts

retryAttempts: object

defaultValue

defaultValue: number = 10

serializedName

serializedName: string = "retryAttempts"

type

type: object

name

name: "Number" = "Number"

retryIntervalBackoffMultiplier

retryIntervalBackoffMultiplier: object

defaultValue

defaultValue: number = 2

serializedName

serializedName: string = "retryIntervalBackoffMultiplier"

type

type: object

name

name: "Number" = "Number"

timeoutSeconds

timeoutSeconds: object

defaultValue

defaultValue: number = 43200

serializedName

serializedName: string = "timeoutSeconds"

type

type: object

name

name: "Number" = "Number"

Const JobStepListResult

JobStepListResult: object
interface

A list of job steps.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobStepListResult"

__@iterator

  • __@iterator(): IterableIterator<JobStep>
  • Iterator

    Returns IterableIterator<JobStep>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<JobStep>[]): JobStep[]
  • concat(...items: (T | ConcatArray<T>)[]): JobStep[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<JobStep>[]

      Additional items to add to the end of array1.

    Returns JobStep[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns JobStep[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, JobStep]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, JobStep]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: JobStep, index: number, array: JobStep[]): boolean
        • Parameters

          • value: JobStep
          • index: number
          • array: JobStep[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: JobStep, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: JobStep

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): JobStep[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: JobStep

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobStep, index: number, array: JobStep[]): boolean
        • Parameters

          • value: JobStep
          • index: number
          • array: JobStep[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobStep, index: number, array: JobStep[]): any
        • Parameters

          • value: JobStep
          • index: number
          • array: JobStep[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns JobStep[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): JobStep | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: JobStep

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: JobStep, index: number, obj: JobStep[]): boolean
        • Parameters

          • this: void
          • value: JobStep
          • index: number
          • obj: JobStep[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: JobStep, index: number, obj: JobStep[]): boolean
        • Parameters

          • value: JobStep
          • index: number
          • obj: JobStep[]

          Returns boolean

    • Optional thisArg: any

    Returns JobStep | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: JobStep, index: number, obj: JobStep[]): boolean
        • Parameters

          • value: JobStep
          • index: number
          • obj: JobStep[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: JobStep, index: number, array: JobStep[]): void
        • Parameters

          • value: JobStep
          • index: number
          • array: JobStep[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: JobStep, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: JobStep

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: JobStep, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: JobStep

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: JobStep, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: JobStep

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: JobStep, index: number, array: JobStep[]): U
        • Parameters

          • value: JobStep
          • index: number
          • array: JobStep[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): JobStep | undefined
  • Removes the last element from an array and returns it.

    Returns JobStep | undefined

push

  • push(...items: JobStep[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: JobStep[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): JobStep
  • reduce(callbackfn: function, initialValue: JobStep): JobStep
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobStep, currentValue: JobStep, currentIndex: number, array: JobStep[]): JobStep
        • Parameters

          • previousValue: JobStep
          • currentValue: JobStep
          • currentIndex: number
          • array: JobStep[]

          Returns JobStep

    Returns JobStep

  • Parameters

    • callbackfn: function
        • (previousValue: JobStep, currentValue: JobStep, currentIndex: number, array: JobStep[]): JobStep
        • Parameters

          • previousValue: JobStep
          • currentValue: JobStep
          • currentIndex: number
          • array: JobStep[]

          Returns JobStep

    • initialValue: JobStep

    Returns JobStep

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobStep, currentIndex: number, array: JobStep[]): U
        • Parameters

          • previousValue: U
          • currentValue: JobStep
          • currentIndex: number
          • array: JobStep[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): JobStep
  • reduceRight(callbackfn: function, initialValue: JobStep): JobStep
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobStep, currentValue: JobStep, currentIndex: number, array: JobStep[]): JobStep
        • Parameters

          • previousValue: JobStep
          • currentValue: JobStep
          • currentIndex: number
          • array: JobStep[]

          Returns JobStep

    Returns JobStep

  • Parameters

    • callbackfn: function
        • (previousValue: JobStep, currentValue: JobStep, currentIndex: number, array: JobStep[]): JobStep
        • Parameters

          • previousValue: JobStep
          • currentValue: JobStep
          • currentIndex: number
          • array: JobStep[]

          Returns JobStep

    • initialValue: JobStep

    Returns JobStep

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobStep, currentIndex: number, array: JobStep[]): U
        • Parameters

          • previousValue: U
          • currentValue: JobStep
          • currentIndex: number
          • array: JobStep[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): JobStep[]
  • Reverses the elements in an Array.

    Returns JobStep[]

shift

  • shift(): JobStep | undefined
  • Removes the first element from an array and returns it.

    Returns JobStep | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): JobStep[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns JobStep[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: JobStep, index: number, array: JobStep[]): boolean
        • Parameters

          • value: JobStep
          • index: number
          • array: JobStep[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): JobStep[]
  • splice(start: number, deleteCount: number, ...items: JobStep[]): JobStep[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns JobStep[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: JobStep[]

      Elements to insert into the array in place of the deleted elements.

    Returns JobStep[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: JobStep[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: JobStep[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<JobStep>
  • Returns an iterable of values in the array

    Returns IterableIterator<JobStep>

type

type: object

className

className: string = "JobStepListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobStep"

name

name: "Composite" = "Composite"

Const JobStepOutput

JobStepOutput: object

The output configuration of a job step.

credential

credential: string

The resource ID of the credential to use to connect to the output destination.

databaseName

databaseName: string

The output destination database.

Optional resourceGroupName

resourceGroupName: undefined | string

The output destination resource group.

Optional schemaName

schemaName: undefined | string

The output destination schema. Default value: 'dbo'.

serializedName

serializedName: string = "JobStepOutput"

serverName

serverName: string

The output destination server name.

Optional subscriptionId

subscriptionId: undefined | string

The output destination subscription id.

tableName

tableName: string

The output destination table.

type

type: object

The output destination type. Possible values include: 'SqlDatabase'. Default value: 'SqlDatabase'.

className

className: string = "JobStepOutput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

credential

credential: object

required

required: true = true

serializedName

serializedName: string = "credential"

type

type: object

name

name: "String" = "String"

databaseName

databaseName: object

required

required: true = true

serializedName

serializedName: string = "databaseName"

type

type: object

name

name: "String" = "String"

resourceGroupName

resourceGroupName: object

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

schemaName

schemaName: object

defaultValue

defaultValue: string = "dbo"

serializedName

serializedName: string = "schemaName"

type

type: object

name

name: "String" = "String"

serverName

serverName: object

required

required: true = true

serializedName

serializedName: string = "serverName"

type

type: object

name

name: "String" = "String"

subscriptionId

subscriptionId: object

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "Uuid" = "Uuid"

tableName

tableName: object

required

required: true = true

serializedName

serializedName: string = "tableName"

type

type: object

name

name: "String" = "String"

type

type: object

defaultValue

defaultValue: string = "SqlDatabase"

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const JobTarget

JobTarget: object

A job target, for example a specific database or a container of databases that is evaluated during job execution.

Optional databaseName

databaseName: undefined | string

The target database name.

Optional elasticPoolName

elasticPoolName: undefined | string

The target elastic pool name.

Optional membershipType

Whether the target is included or excluded from the group. Possible values include: 'Include', 'Exclude'. Default value: 'Include'.

Optional refreshCredential

refreshCredential: undefined | string

The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target.

serializedName

serializedName: string = "JobTarget"

Optional serverName

serverName: undefined | string

The target server name.

Optional shardMapName

shardMapName: undefined | string

The target shard map.

type

type: object

The target type. Possible values include: 'TargetGroup', 'SqlDatabase', 'SqlElasticPool', 'SqlShardMap', 'SqlServer'

className

className: string = "JobTarget"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

databaseName

databaseName: object

serializedName

serializedName: string = "databaseName"

type

type: object

name

name: "String" = "String"

elasticPoolName

elasticPoolName: object

serializedName

serializedName: string = "elasticPoolName"

type

type: object

name

name: "String" = "String"

membershipType

membershipType: object

defaultValue

defaultValue: string = "Include"

serializedName

serializedName: string = "membershipType"

type

type: object

allowedValues

allowedValues: string[] = ["Include","Exclude"]

name

name: "Enum" = "Enum"

refreshCredential

refreshCredential: object

serializedName

serializedName: string = "refreshCredential"

type

type: object

name

name: "String" = "String"

serverName

serverName: object

serializedName

serializedName: string = "serverName"

type

type: object

name

name: "String" = "String"

shardMapName

shardMapName: object

serializedName

serializedName: string = "shardMapName"

type

type: object

name

name: "String" = "String"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const JobTargetGroup

JobTargetGroup: object

A group of job targets.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

members

members: JobTarget[]

Members of the target group.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobTargetGroup"

type

type: object

className

className: string = "JobTargetGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

members

members: object

required

required: true = true

serializedName

serializedName: string = "properties.members"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobTarget"

name

name: "Composite" = "Composite"

Const JobTargetGroupListResult

JobTargetGroupListResult: object
interface

A list of target groups.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobTargetGroupListResult"

__@iterator

  • __@iterator(): IterableIterator<JobTargetGroup>
  • Iterator

    Returns IterableIterator<JobTargetGroup>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<JobTargetGroup>[]): JobTargetGroup[]
  • concat(...items: (T | ConcatArray<T>)[]): JobTargetGroup[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<JobTargetGroup>[]

      Additional items to add to the end of array1.

    Returns JobTargetGroup[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns JobTargetGroup[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, JobTargetGroup]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, JobTargetGroup]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: JobTargetGroup, index: number, array: JobTargetGroup[]): boolean
        • Parameters

          • value: JobTargetGroup
          • index: number
          • array: JobTargetGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: JobTargetGroup, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: JobTargetGroup

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): JobTargetGroup[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: JobTargetGroup

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobTargetGroup, index: number, array: JobTargetGroup[]): boolean
        • Parameters

          • value: JobTargetGroup
          • index: number
          • array: JobTargetGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobTargetGroup, index: number, array: JobTargetGroup[]): any
        • Parameters

          • value: JobTargetGroup
          • index: number
          • array: JobTargetGroup[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns JobTargetGroup[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): JobTargetGroup | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: JobTargetGroup

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: JobTargetGroup, index: number, obj: JobTargetGroup[]): boolean
        • Parameters

          • this: void
          • value: JobTargetGroup
          • index: number
          • obj: JobTargetGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: JobTargetGroup, index: number, obj: JobTargetGroup[]): boolean
        • Parameters

          • value: JobTargetGroup
          • index: number
          • obj: JobTargetGroup[]

          Returns boolean

    • Optional thisArg: any

    Returns JobTargetGroup | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: JobTargetGroup, index: number, obj: JobTargetGroup[]): boolean
        • Parameters

          • value: JobTargetGroup
          • index: number
          • obj: JobTargetGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: JobTargetGroup, index: number, array: JobTargetGroup[]): void
        • Parameters

          • value: JobTargetGroup
          • index: number
          • array: JobTargetGroup[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: JobTargetGroup, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: JobTargetGroup

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: JobTargetGroup, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: JobTargetGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: JobTargetGroup, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: JobTargetGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: JobTargetGroup, index: number, array: JobTargetGroup[]): U
        • Parameters

          • value: JobTargetGroup
          • index: number
          • array: JobTargetGroup[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): JobTargetGroup | undefined
  • Removes the last element from an array and returns it.

    Returns JobTargetGroup | undefined

push

  • push(...items: JobTargetGroup[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: JobTargetGroup[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): JobTargetGroup
  • reduce(callbackfn: function, initialValue: JobTargetGroup): JobTargetGroup
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobTargetGroup, currentValue: JobTargetGroup, currentIndex: number, array: JobTargetGroup[]): JobTargetGroup
        • Parameters

          • previousValue: JobTargetGroup
          • currentValue: JobTargetGroup
          • currentIndex: number
          • array: JobTargetGroup[]

          Returns JobTargetGroup

    Returns JobTargetGroup

  • Parameters

    • callbackfn: function
        • (previousValue: JobTargetGroup, currentValue: JobTargetGroup, currentIndex: number, array: JobTargetGroup[]): JobTargetGroup
        • Parameters

          • previousValue: JobTargetGroup
          • currentValue: JobTargetGroup
          • currentIndex: number
          • array: JobTargetGroup[]

          Returns JobTargetGroup

    • initialValue: JobTargetGroup

    Returns JobTargetGroup

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobTargetGroup, currentIndex: number, array: JobTargetGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: JobTargetGroup
          • currentIndex: number
          • array: JobTargetGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): JobTargetGroup
  • reduceRight(callbackfn: function, initialValue: JobTargetGroup): JobTargetGroup
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobTargetGroup, currentValue: JobTargetGroup, currentIndex: number, array: JobTargetGroup[]): JobTargetGroup
        • Parameters

          • previousValue: JobTargetGroup
          • currentValue: JobTargetGroup
          • currentIndex: number
          • array: JobTargetGroup[]

          Returns JobTargetGroup

    Returns JobTargetGroup

  • Parameters

    • callbackfn: function
        • (previousValue: JobTargetGroup, currentValue: JobTargetGroup, currentIndex: number, array: JobTargetGroup[]): JobTargetGroup
        • Parameters

          • previousValue: JobTargetGroup
          • currentValue: JobTargetGroup
          • currentIndex: number
          • array: JobTargetGroup[]

          Returns JobTargetGroup

    • initialValue: JobTargetGroup

    Returns JobTargetGroup

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobTargetGroup, currentIndex: number, array: JobTargetGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: JobTargetGroup
          • currentIndex: number
          • array: JobTargetGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): JobTargetGroup[]
  • Reverses the elements in an Array.

    Returns JobTargetGroup[]

shift

  • shift(): JobTargetGroup | undefined
  • Removes the first element from an array and returns it.

    Returns JobTargetGroup | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): JobTargetGroup[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns JobTargetGroup[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: JobTargetGroup, index: number, array: JobTargetGroup[]): boolean
        • Parameters

          • value: JobTargetGroup
          • index: number
          • array: JobTargetGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): JobTargetGroup[]
  • splice(start: number, deleteCount: number, ...items: JobTargetGroup[]): JobTargetGroup[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns JobTargetGroup[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: JobTargetGroup[]

      Elements to insert into the array in place of the deleted elements.

    Returns JobTargetGroup[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: JobTargetGroup[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: JobTargetGroup[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<JobTargetGroup>
  • Returns an iterable of values in the array

    Returns IterableIterator<JobTargetGroup>

type

type: object

className

className: string = "JobTargetGroupListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobTargetGroup"

name

name: "Composite" = "Composite"

Const JobVersion

JobVersion: object

A job version.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobVersion"

type

type: object

className

className: string = "JobVersion"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

Const JobVersionListResult

JobVersionListResult: object
interface

A list of job versions.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobVersionListResult"

__@iterator

  • __@iterator(): IterableIterator<JobVersion>
  • Iterator

    Returns IterableIterator<JobVersion>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<JobVersion>[]): JobVersion[]
  • concat(...items: (T | ConcatArray<T>)[]): JobVersion[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<JobVersion>[]

      Additional items to add to the end of array1.

    Returns JobVersion[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns JobVersion[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, JobVersion]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, JobVersion]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: JobVersion, index: number, array: JobVersion[]): boolean
        • Parameters

          • value: JobVersion
          • index: number
          • array: JobVersion[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: JobVersion, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: JobVersion

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): JobVersion[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: JobVersion

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobVersion, index: number, array: JobVersion[]): boolean
        • Parameters

          • value: JobVersion
          • index: number
          • array: JobVersion[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobVersion, index: number, array: JobVersion[]): any
        • Parameters

          • value: JobVersion
          • index: number
          • array: JobVersion[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns JobVersion[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): JobVersion | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: JobVersion

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: JobVersion, index: number, obj: JobVersion[]): boolean
        • Parameters

          • this: void
          • value: JobVersion
          • index: number
          • obj: JobVersion[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: JobVersion, index: number, obj: JobVersion[]): boolean
        • Parameters

          • value: JobVersion
          • index: number
          • obj: JobVersion[]

          Returns boolean

    • Optional thisArg: any

    Returns JobVersion | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: JobVersion, index: number, obj: JobVersion[]): boolean
        • Parameters

          • value: JobVersion
          • index: number
          • obj: JobVersion[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: JobVersion, index: number, array: JobVersion[]): void
        • Parameters

          • value: JobVersion
          • index: number
          • array: JobVersion[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: JobVersion, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: JobVersion

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: JobVersion, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: JobVersion

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: JobVersion, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: JobVersion

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: JobVersion, index: number, array: JobVersion[]): U
        • Parameters

          • value: JobVersion
          • index: number
          • array: JobVersion[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): JobVersion | undefined
  • Removes the last element from an array and returns it.

    Returns JobVersion | undefined

push

  • push(...items: JobVersion[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: JobVersion[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): JobVersion
  • reduce(callbackfn: function, initialValue: JobVersion): JobVersion
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobVersion, currentValue: JobVersion, currentIndex: number, array: JobVersion[]): JobVersion
        • Parameters

          • previousValue: JobVersion
          • currentValue: JobVersion
          • currentIndex: number
          • array: JobVersion[]

          Returns JobVersion

    Returns JobVersion

  • Parameters

    • callbackfn: function
        • (previousValue: JobVersion, currentValue: JobVersion, currentIndex: number, array: JobVersion[]): JobVersion
        • Parameters

          • previousValue: JobVersion
          • currentValue: JobVersion
          • currentIndex: number
          • array: JobVersion[]

          Returns JobVersion

    • initialValue: JobVersion

    Returns JobVersion

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobVersion, currentIndex: number, array: JobVersion[]): U
        • Parameters

          • previousValue: U
          • currentValue: JobVersion
          • currentIndex: number
          • array: JobVersion[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): JobVersion
  • reduceRight(callbackfn: function, initialValue: JobVersion): JobVersion
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobVersion, currentValue: JobVersion, currentIndex: number, array: JobVersion[]): JobVersion
        • Parameters

          • previousValue: JobVersion
          • currentValue: JobVersion
          • currentIndex: number
          • array: JobVersion[]

          Returns JobVersion

    Returns JobVersion

  • Parameters

    • callbackfn: function
        • (previousValue: JobVersion, currentValue: JobVersion, currentIndex: number, array: JobVersion[]): JobVersion
        • Parameters

          • previousValue: JobVersion
          • currentValue: JobVersion
          • currentIndex: number
          • array: JobVersion[]

          Returns JobVersion

    • initialValue: JobVersion

    Returns JobVersion

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobVersion, currentIndex: number, array: JobVersion[]): U
        • Parameters

          • previousValue: U
          • currentValue: JobVersion
          • currentIndex: number
          • array: JobVersion[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): JobVersion[]
  • Reverses the elements in an Array.

    Returns JobVersion[]

shift

  • shift(): JobVersion | undefined
  • Removes the first element from an array and returns it.

    Returns JobVersion | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): JobVersion[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns JobVersion[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: JobVersion, index: number, array: JobVersion[]): boolean
        • Parameters

          • value: JobVersion
          • index: number
          • array: JobVersion[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): JobVersion[]
  • splice(start: number, deleteCount: number, ...items: JobVersion[]): JobVersion[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns JobVersion[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: JobVersion[]

      Elements to insert into the array in place of the deleted elements.

    Returns JobVersion[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: JobVersion[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: JobVersion[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<JobVersion>
  • Returns an iterable of values in the array

    Returns IterableIterator<JobVersion>

type

type: object

className

className: string = "JobVersionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobVersion"

name

name: "Composite" = "Composite"

Const LicenseTypeCapability

LicenseTypeCapability: object

The license type capability

Optional name

name: undefined | string

License type identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "LicenseTypeCapability"

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "LicenseTypeCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

Const LocationCapabilities

LocationCapabilities: object

The location capability.

Optional name

name: undefined | string

The location name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "LocationCapabilities"

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedManagedInstanceVersions

supportedManagedInstanceVersions: ManagedInstanceVersionCapability[]

The list of supported managed instance versions. NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedServerVersions

supportedServerVersions: ServerVersionCapability[]

The list of supported server versions. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "LocationCapabilities"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

supportedManagedInstanceVersions

supportedManagedInstanceVersions: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedManagedInstanceVersions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedInstanceVersionCapability"

name

name: "Composite" = "Composite"

supportedServerVersions

supportedServerVersions: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedServerVersions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServerVersionCapability"

name

name: "Composite" = "Composite"

Const LogSizeCapability

LogSizeCapability: object

The log size capability.

Optional limit

limit: undefined | number

The log size limit (see 'unit' for the units). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LogSizeCapability"

Optional unit

The units that the limit is expressed in. Possible values include: 'Megabytes', 'Gigabytes', 'Terabytes', 'Petabytes', 'Percent' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "LogSizeCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

limit

limit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "limit"

type

type: object

name

name: "Number" = "Number"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const LogicalServerSecurityAlertPolicyListResult

LogicalServerSecurityAlertPolicyListResult: object
interface

A list of the server's security alert policies.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LogicalServerSecurityAlertPolicyListResult"

__@iterator

  • __@iterator(): IterableIterator<ServerSecurityAlertPolicy>
  • Iterator

    Returns IterableIterator<ServerSecurityAlertPolicy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ServerSecurityAlertPolicy>[]): ServerSecurityAlertPolicy[]
  • concat(...items: (T | ConcatArray<T>)[]): ServerSecurityAlertPolicy[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServerSecurityAlertPolicy>[]

      Additional items to add to the end of array1.

    Returns ServerSecurityAlertPolicy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServerSecurityAlertPolicy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ServerSecurityAlertPolicy]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServerSecurityAlertPolicy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ServerSecurityAlertPolicy, index: number, array: ServerSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ServerSecurityAlertPolicy
          • index: number
          • array: ServerSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServerSecurityAlertPolicy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServerSecurityAlertPolicy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServerSecurityAlertPolicy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ServerSecurityAlertPolicy

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerSecurityAlertPolicy, index: number, array: ServerSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ServerSecurityAlertPolicy
          • index: number
          • array: ServerSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerSecurityAlertPolicy, index: number, array: ServerSecurityAlertPolicy[]): any
        • Parameters

          • value: ServerSecurityAlertPolicy
          • index: number
          • array: ServerSecurityAlertPolicy[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServerSecurityAlertPolicy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServerSecurityAlertPolicy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ServerSecurityAlertPolicy

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ServerSecurityAlertPolicy, index: number, obj: ServerSecurityAlertPolicy[]): boolean
        • Parameters

          • this: void
          • value: ServerSecurityAlertPolicy
          • index: number
          • obj: ServerSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ServerSecurityAlertPolicy, index: number, obj: ServerSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ServerSecurityAlertPolicy
          • index: number
          • obj: ServerSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

    Returns ServerSecurityAlertPolicy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ServerSecurityAlertPolicy, index: number, obj: ServerSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ServerSecurityAlertPolicy
          • index: number
          • obj: ServerSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ServerSecurityAlertPolicy, index: number, array: ServerSecurityAlertPolicy[]): void
        • Parameters

          • value: ServerSecurityAlertPolicy
          • index: number
          • array: ServerSecurityAlertPolicy[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServerSecurityAlertPolicy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServerSecurityAlertPolicy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServerSecurityAlertPolicy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServerSecurityAlertPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServerSecurityAlertPolicy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServerSecurityAlertPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ServerSecurityAlertPolicy, index: number, array: ServerSecurityAlertPolicy[]): U
        • Parameters

          • value: ServerSecurityAlertPolicy
          • index: number
          • array: ServerSecurityAlertPolicy[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ServerSecurityAlertPolicy | undefined
  • Removes the last element from an array and returns it.

    Returns ServerSecurityAlertPolicy | undefined

push

  • push(...items: ServerSecurityAlertPolicy[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ServerSecurityAlertPolicy[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ServerSecurityAlertPolicy
  • reduce(callbackfn: function, initialValue: ServerSecurityAlertPolicy): ServerSecurityAlertPolicy
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerSecurityAlertPolicy, currentValue: ServerSecurityAlertPolicy, currentIndex: number, array: ServerSecurityAlertPolicy[]): ServerSecurityAlertPolicy
        • Parameters

          • previousValue: ServerSecurityAlertPolicy
          • currentValue: ServerSecurityAlertPolicy
          • currentIndex: number
          • array: ServerSecurityAlertPolicy[]

          Returns ServerSecurityAlertPolicy

    Returns ServerSecurityAlertPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: ServerSecurityAlertPolicy, currentValue: ServerSecurityAlertPolicy, currentIndex: number, array: ServerSecurityAlertPolicy[]): ServerSecurityAlertPolicy
        • Parameters

          • previousValue: ServerSecurityAlertPolicy
          • currentValue: ServerSecurityAlertPolicy
          • currentIndex: number
          • array: ServerSecurityAlertPolicy[]

          Returns ServerSecurityAlertPolicy

    • initialValue: ServerSecurityAlertPolicy

    Returns ServerSecurityAlertPolicy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerSecurityAlertPolicy, currentIndex: number, array: ServerSecurityAlertPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerSecurityAlertPolicy
          • currentIndex: number
          • array: ServerSecurityAlertPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ServerSecurityAlertPolicy
  • reduceRight(callbackfn: function, initialValue: ServerSecurityAlertPolicy): ServerSecurityAlertPolicy
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerSecurityAlertPolicy, currentValue: ServerSecurityAlertPolicy, currentIndex: number, array: ServerSecurityAlertPolicy[]): ServerSecurityAlertPolicy
        • Parameters

          • previousValue: ServerSecurityAlertPolicy
          • currentValue: ServerSecurityAlertPolicy
          • currentIndex: number
          • array: ServerSecurityAlertPolicy[]

          Returns ServerSecurityAlertPolicy

    Returns ServerSecurityAlertPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: ServerSecurityAlertPolicy, currentValue: ServerSecurityAlertPolicy, currentIndex: number, array: ServerSecurityAlertPolicy[]): ServerSecurityAlertPolicy
        • Parameters

          • previousValue: ServerSecurityAlertPolicy
          • currentValue: ServerSecurityAlertPolicy
          • currentIndex: number
          • array: ServerSecurityAlertPolicy[]

          Returns ServerSecurityAlertPolicy

    • initialValue: ServerSecurityAlertPolicy

    Returns ServerSecurityAlertPolicy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerSecurityAlertPolicy, currentIndex: number, array: ServerSecurityAlertPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerSecurityAlertPolicy
          • currentIndex: number
          • array: ServerSecurityAlertPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ServerSecurityAlertPolicy[]
  • Reverses the elements in an Array.

    Returns ServerSecurityAlertPolicy[]

shift

  • shift(): ServerSecurityAlertPolicy | undefined
  • Removes the first element from an array and returns it.

    Returns ServerSecurityAlertPolicy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServerSecurityAlertPolicy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServerSecurityAlertPolicy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ServerSecurityAlertPolicy, index: number, array: ServerSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ServerSecurityAlertPolicy
          • index: number
          • array: ServerSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ServerSecurityAlertPolicy[]
  • splice(start: number, deleteCount: number, ...items: ServerSecurityAlertPolicy[]): ServerSecurityAlertPolicy[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServerSecurityAlertPolicy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServerSecurityAlertPolicy[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServerSecurityAlertPolicy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ServerSecurityAlertPolicy[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServerSecurityAlertPolicy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ServerSecurityAlertPolicy>
  • Returns an iterable of values in the array

    Returns IterableIterator<ServerSecurityAlertPolicy>

type

type: object

className

className: string = "LogicalServerSecurityAlertPolicyListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServerSecurityAlertPolicy"

name

name: "Composite" = "Composite"

Const LongTermRetentionBackup

LongTermRetentionBackup: object

A long term retention backup.

Optional backupExpirationTime

backupExpirationTime: Date

The time the long term retention backup will expire. NOTE: This property will not be serialized. It can only be populated by the server.

Optional backupTime

backupTime: Date

The time the backup was taken NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseDeletionTime

databaseDeletionTime: Date

The delete time of the database NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseName

databaseName: undefined | string

The name of the database the backup belong to NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LongTermRetentionBackup"

Optional serverCreateTime

serverCreateTime: Date

The create time of the server. NOTE: This property will not be serialized. It can only be populated by the server.

Optional serverName

serverName: undefined | string

The server name that the backup database belong to. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "LongTermRetentionBackup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupExpirationTime

backupExpirationTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.backupExpirationTime"

type

type: object

name

name: "DateTime" = "DateTime"

backupTime

backupTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.backupTime"

type

type: object

name

name: "DateTime" = "DateTime"

databaseDeletionTime

databaseDeletionTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseDeletionTime"

type

type: object

name

name: "DateTime" = "DateTime"

databaseName

databaseName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseName"

type

type: object

name

name: "String" = "String"

serverCreateTime

serverCreateTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serverCreateTime"

type

type: object

name

name: "DateTime" = "DateTime"

serverName

serverName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serverName"

type

type: object

name

name: "String" = "String"

Const LongTermRetentionBackupListResult

LongTermRetentionBackupListResult: object
interface

A list of long term retention backups.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LongTermRetentionBackupListResult"

__@iterator

  • __@iterator(): IterableIterator<LongTermRetentionBackup>
  • Iterator

    Returns IterableIterator<LongTermRetentionBackup>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LongTermRetentionBackup>[]): LongTermRetentionBackup[]
  • concat(...items: (T | ConcatArray<T>)[]): LongTermRetentionBackup[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LongTermRetentionBackup>[]

      Additional items to add to the end of array1.

    Returns LongTermRetentionBackup[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LongTermRetentionBackup[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LongTermRetentionBackup]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LongTermRetentionBackup]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: LongTermRetentionBackup, index: number, array: LongTermRetentionBackup[]): boolean
        • Parameters

          • value: LongTermRetentionBackup
          • index: number
          • array: LongTermRetentionBackup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LongTermRetentionBackup, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LongTermRetentionBackup

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LongTermRetentionBackup[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: LongTermRetentionBackup

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LongTermRetentionBackup, index: number, array: LongTermRetentionBackup[]): boolean
        • Parameters

          • value: LongTermRetentionBackup
          • index: number
          • array: LongTermRetentionBackup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LongTermRetentionBackup, index: number, array: LongTermRetentionBackup[]): any
        • Parameters

          • value: LongTermRetentionBackup
          • index: number
          • array: LongTermRetentionBackup[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LongTermRetentionBackup[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LongTermRetentionBackup | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: LongTermRetentionBackup

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LongTermRetentionBackup, index: number, obj: LongTermRetentionBackup[]): boolean
        • Parameters

          • this: void
          • value: LongTermRetentionBackup
          • index: number
          • obj: LongTermRetentionBackup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: LongTermRetentionBackup, index: number, obj: LongTermRetentionBackup[]): boolean
        • Parameters

          • value: LongTermRetentionBackup
          • index: number
          • obj: LongTermRetentionBackup[]

          Returns boolean

    • Optional thisArg: any

    Returns LongTermRetentionBackup | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: LongTermRetentionBackup, index: number, obj: LongTermRetentionBackup[]): boolean
        • Parameters

          • value: LongTermRetentionBackup
          • index: number
          • obj: LongTermRetentionBackup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: LongTermRetentionBackup, index: number, array: LongTermRetentionBackup[]): void
        • Parameters

          • value: LongTermRetentionBackup
          • index: number
          • array: LongTermRetentionBackup[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LongTermRetentionBackup, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LongTermRetentionBackup

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LongTermRetentionBackup, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LongTermRetentionBackup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LongTermRetentionBackup, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LongTermRetentionBackup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: LongTermRetentionBackup, index: number, array: LongTermRetentionBackup[]): U
        • Parameters

          • value: LongTermRetentionBackup
          • index: number
          • array: LongTermRetentionBackup[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): LongTermRetentionBackup | undefined
  • Removes the last element from an array and returns it.

    Returns LongTermRetentionBackup | undefined

push

  • push(...items: LongTermRetentionBackup[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LongTermRetentionBackup[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LongTermRetentionBackup
  • reduce(callbackfn: function, initialValue: LongTermRetentionBackup): LongTermRetentionBackup
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: LongTermRetentionBackup, currentValue: LongTermRetentionBackup, currentIndex: number, array: LongTermRetentionBackup[]): LongTermRetentionBackup
        • Parameters

          • previousValue: LongTermRetentionBackup
          • currentValue: LongTermRetentionBackup
          • currentIndex: number
          • array: LongTermRetentionBackup[]

          Returns LongTermRetentionBackup

    Returns LongTermRetentionBackup

  • Parameters

    • callbackfn: function
        • (previousValue: LongTermRetentionBackup, currentValue: LongTermRetentionBackup, currentIndex: number, array: LongTermRetentionBackup[]): LongTermRetentionBackup
        • Parameters

          • previousValue: LongTermRetentionBackup
          • currentValue: LongTermRetentionBackup
          • currentIndex: number
          • array: LongTermRetentionBackup[]

          Returns LongTermRetentionBackup

    • initialValue: LongTermRetentionBackup

    Returns LongTermRetentionBackup

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LongTermRetentionBackup, currentIndex: number, array: LongTermRetentionBackup[]): U
        • Parameters

          • previousValue: U
          • currentValue: LongTermRetentionBackup
          • currentIndex: number
          • array: LongTermRetentionBackup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LongTermRetentionBackup
  • reduceRight(callbackfn: function, initialValue: LongTermRetentionBackup): LongTermRetentionBackup
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: LongTermRetentionBackup, currentValue: LongTermRetentionBackup, currentIndex: number, array: LongTermRetentionBackup[]): LongTermRetentionBackup
        • Parameters

          • previousValue: LongTermRetentionBackup
          • currentValue: LongTermRetentionBackup
          • currentIndex: number
          • array: LongTermRetentionBackup[]

          Returns LongTermRetentionBackup

    Returns LongTermRetentionBackup

  • Parameters

    • callbackfn: function
        • (previousValue: LongTermRetentionBackup, currentValue: LongTermRetentionBackup, currentIndex: number, array: LongTermRetentionBackup[]): LongTermRetentionBackup
        • Parameters

          • previousValue: LongTermRetentionBackup
          • currentValue: LongTermRetentionBackup
          • currentIndex: number
          • array: LongTermRetentionBackup[]

          Returns LongTermRetentionBackup

    • initialValue: LongTermRetentionBackup

    Returns LongTermRetentionBackup

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LongTermRetentionBackup, currentIndex: number, array: LongTermRetentionBackup[]): U
        • Parameters

          • previousValue: U
          • currentValue: LongTermRetentionBackup
          • currentIndex: number
          • array: LongTermRetentionBackup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): LongTermRetentionBackup[]
  • Reverses the elements in an Array.

    Returns LongTermRetentionBackup[]

shift

  • shift(): LongTermRetentionBackup | undefined
  • Removes the first element from an array and returns it.

    Returns LongTermRetentionBackup | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LongTermRetentionBackup[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LongTermRetentionBackup[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: LongTermRetentionBackup, index: number, array: LongTermRetentionBackup[]): boolean
        • Parameters

          • value: LongTermRetentionBackup
          • index: number
          • array: LongTermRetentionBackup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LongTermRetentionBackup[]
  • splice(start: number, deleteCount: number, ...items: LongTermRetentionBackup[]): LongTermRetentionBackup[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LongTermRetentionBackup[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LongTermRetentionBackup[]

      Elements to insert into the array in place of the deleted elements.

    Returns LongTermRetentionBackup[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LongTermRetentionBackup[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LongTermRetentionBackup[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LongTermRetentionBackup>
  • Returns an iterable of values in the array

    Returns IterableIterator<LongTermRetentionBackup>

type

type: object

className

className: string = "LongTermRetentionBackupListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LongTermRetentionBackup"

name

name: "Composite" = "Composite"

Const ManagedBackupShortTermRetentionPolicy

ManagedBackupShortTermRetentionPolicy: object

A short term retention policy.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional retentionDays

retentionDays: undefined | number

The backup retention period in days. This is how many days Point-in-Time Restore will be supported.

serializedName

serializedName: string = "ManagedBackupShortTermRetentionPolicy"

type

type: object

className

className: string = "ManagedBackupShortTermRetentionPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

retentionDays

retentionDays: object

serializedName

serializedName: string = "properties.retentionDays"

type

type: object

name

name: "Number" = "Number"

Const ManagedBackupShortTermRetentionPolicyListResult

ManagedBackupShortTermRetentionPolicyListResult: object
interface

A list of short term retention policies.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedBackupShortTermRetentionPolicyListResult"

__@iterator

  • __@iterator(): IterableIterator<ManagedBackupShortTermRetentionPolicy>
  • Iterator

    Returns IterableIterator<ManagedBackupShortTermRetentionPolicy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ManagedBackupShortTermRetentionPolicy>[]): ManagedBackupShortTermRetentionPolicy[]
  • concat(...items: (T | ConcatArray<T>)[]): ManagedBackupShortTermRetentionPolicy[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ManagedBackupShortTermRetentionPolicy>[]

      Additional items to add to the end of array1.

    Returns ManagedBackupShortTermRetentionPolicy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ManagedBackupShortTermRetentionPolicy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ManagedBackupShortTermRetentionPolicy]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ManagedBackupShortTermRetentionPolicy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ManagedBackupShortTermRetentionPolicy, index: number, array: ManagedBackupShortTermRetentionPolicy[]): boolean
        • Parameters

          • value: ManagedBackupShortTermRetentionPolicy
          • index: number
          • array: ManagedBackupShortTermRetentionPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ManagedBackupShortTermRetentionPolicy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ManagedBackupShortTermRetentionPolicy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ManagedBackupShortTermRetentionPolicy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ManagedBackupShortTermRetentionPolicy

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedBackupShortTermRetentionPolicy, index: number, array: ManagedBackupShortTermRetentionPolicy[]): boolean
        • Parameters

          • value: ManagedBackupShortTermRetentionPolicy
          • index: number
          • array: ManagedBackupShortTermRetentionPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedBackupShortTermRetentionPolicy, index: number, array: ManagedBackupShortTermRetentionPolicy[]): any
        • Parameters

          • value: ManagedBackupShortTermRetentionPolicy
          • index: number
          • array: ManagedBackupShortTermRetentionPolicy[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ManagedBackupShortTermRetentionPolicy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ManagedBackupShortTermRetentionPolicy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ManagedBackupShortTermRetentionPolicy

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ManagedBackupShortTermRetentionPolicy, index: number, obj: ManagedBackupShortTermRetentionPolicy[]): boolean
        • Parameters

          • this: void
          • value: ManagedBackupShortTermRetentionPolicy
          • index: number
          • obj: ManagedBackupShortTermRetentionPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ManagedBackupShortTermRetentionPolicy, index: number, obj: ManagedBackupShortTermRetentionPolicy[]): boolean
        • Parameters

          • value: ManagedBackupShortTermRetentionPolicy
          • index: number
          • obj: ManagedBackupShortTermRetentionPolicy[]

          Returns boolean

    • Optional thisArg: any

    Returns ManagedBackupShortTermRetentionPolicy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ManagedBackupShortTermRetentionPolicy, index: number, obj: ManagedBackupShortTermRetentionPolicy[]): boolean
        • Parameters

          • value: ManagedBackupShortTermRetentionPolicy
          • index: number
          • obj: ManagedBackupShortTermRetentionPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ManagedBackupShortTermRetentionPolicy, index: number, array: ManagedBackupShortTermRetentionPolicy[]): void
        • Parameters

          • value: ManagedBackupShortTermRetentionPolicy
          • index: number
          • array: ManagedBackupShortTermRetentionPolicy[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ManagedBackupShortTermRetentionPolicy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ManagedBackupShortTermRetentionPolicy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ManagedBackupShortTermRetentionPolicy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ManagedBackupShortTermRetentionPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ManagedBackupShortTermRetentionPolicy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ManagedBackupShortTermRetentionPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ManagedBackupShortTermRetentionPolicy, index: number, array: ManagedBackupShortTermRetentionPolicy[]): U
        • Parameters

          • value: ManagedBackupShortTermRetentionPolicy
          • index: number
          • array: ManagedBackupShortTermRetentionPolicy[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ManagedBackupShortTermRetentionPolicy | undefined
  • Removes the last element from an array and returns it.

    Returns ManagedBackupShortTermRetentionPolicy | undefined

push

  • push(...items: ManagedBackupShortTermRetentionPolicy[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ManagedBackupShortTermRetentionPolicy[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ManagedBackupShortTermRetentionPolicy
  • reduce(callbackfn: function, initialValue: ManagedBackupShortTermRetentionPolicy): ManagedBackupShortTermRetentionPolicy
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedBackupShortTermRetentionPolicy, currentValue: ManagedBackupShortTermRetentionPolicy, currentIndex: number, array: ManagedBackupShortTermRetentionPolicy[]): ManagedBackupShortTermRetentionPolicy
        • Parameters

          • previousValue: ManagedBackupShortTermRetentionPolicy
          • currentValue: ManagedBackupShortTermRetentionPolicy
          • currentIndex: number
          • array: ManagedBackupShortTermRetentionPolicy[]

          Returns ManagedBackupShortTermRetentionPolicy

    Returns ManagedBackupShortTermRetentionPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedBackupShortTermRetentionPolicy, currentValue: ManagedBackupShortTermRetentionPolicy, currentIndex: number, array: ManagedBackupShortTermRetentionPolicy[]): ManagedBackupShortTermRetentionPolicy
        • Parameters

          • previousValue: ManagedBackupShortTermRetentionPolicy
          • currentValue: ManagedBackupShortTermRetentionPolicy
          • currentIndex: number
          • array: ManagedBackupShortTermRetentionPolicy[]

          Returns ManagedBackupShortTermRetentionPolicy

    • initialValue: ManagedBackupShortTermRetentionPolicy

    Returns ManagedBackupShortTermRetentionPolicy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedBackupShortTermRetentionPolicy, currentIndex: number, array: ManagedBackupShortTermRetentionPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedBackupShortTermRetentionPolicy
          • currentIndex: number
          • array: ManagedBackupShortTermRetentionPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ManagedBackupShortTermRetentionPolicy
  • reduceRight(callbackfn: function, initialValue: ManagedBackupShortTermRetentionPolicy): ManagedBackupShortTermRetentionPolicy
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedBackupShortTermRetentionPolicy, currentValue: ManagedBackupShortTermRetentionPolicy, currentIndex: number, array: ManagedBackupShortTermRetentionPolicy[]): ManagedBackupShortTermRetentionPolicy
        • Parameters

          • previousValue: ManagedBackupShortTermRetentionPolicy
          • currentValue: ManagedBackupShortTermRetentionPolicy
          • currentIndex: number
          • array: ManagedBackupShortTermRetentionPolicy[]

          Returns ManagedBackupShortTermRetentionPolicy

    Returns ManagedBackupShortTermRetentionPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedBackupShortTermRetentionPolicy, currentValue: ManagedBackupShortTermRetentionPolicy, currentIndex: number, array: ManagedBackupShortTermRetentionPolicy[]): ManagedBackupShortTermRetentionPolicy
        • Parameters

          • previousValue: ManagedBackupShortTermRetentionPolicy
          • currentValue: ManagedBackupShortTermRetentionPolicy
          • currentIndex: number
          • array: ManagedBackupShortTermRetentionPolicy[]

          Returns ManagedBackupShortTermRetentionPolicy

    • initialValue: ManagedBackupShortTermRetentionPolicy

    Returns ManagedBackupShortTermRetentionPolicy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedBackupShortTermRetentionPolicy, currentIndex: number, array: ManagedBackupShortTermRetentionPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedBackupShortTermRetentionPolicy
          • currentIndex: number
          • array: ManagedBackupShortTermRetentionPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ManagedBackupShortTermRetentionPolicy[]
  • Reverses the elements in an Array.

    Returns ManagedBackupShortTermRetentionPolicy[]

shift

  • shift(): ManagedBackupShortTermRetentionPolicy | undefined
  • Removes the first element from an array and returns it.

    Returns ManagedBackupShortTermRetentionPolicy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ManagedBackupShortTermRetentionPolicy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ManagedBackupShortTermRetentionPolicy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ManagedBackupShortTermRetentionPolicy, index: number, array: ManagedBackupShortTermRetentionPolicy[]): boolean
        • Parameters

          • value: ManagedBackupShortTermRetentionPolicy
          • index: number
          • array: ManagedBackupShortTermRetentionPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ManagedBackupShortTermRetentionPolicy[]
  • splice(start: number, deleteCount: number, ...items: ManagedBackupShortTermRetentionPolicy[]): ManagedBackupShortTermRetentionPolicy[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ManagedBackupShortTermRetentionPolicy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ManagedBackupShortTermRetentionPolicy[]

      Elements to insert into the array in place of the deleted elements.

    Returns ManagedBackupShortTermRetentionPolicy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ManagedBackupShortTermRetentionPolicy[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ManagedBackupShortTermRetentionPolicy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ManagedBackupShortTermRetentionPolicy>
  • Returns an iterable of values in the array

    Returns IterableIterator<ManagedBackupShortTermRetentionPolicy>

type

type: object

className

className: string = "ManagedBackupShortTermRetentionPolicyListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedBackupShortTermRetentionPolicy"

name

name: "Composite" = "Composite"

Const ManagedDatabase

ManagedDatabase: object

A managed database resource.

Optional catalogCollation

catalogCollation: CatalogCollationType

Collation of the metadata catalog. Possible values include: 'DATABASE_DEFAULT', 'SQL_Latin1_General_CP1_CI_AS'

Optional collation

collation: undefined | string

Collation of the managed database.

Optional createMode

Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. Possible values include: 'Default', 'RestoreExternalBackup', 'PointInTimeRestore', 'Recovery'

Optional creationDate

creationDate: Date

Creation date of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultSecondaryLocation

defaultSecondaryLocation: undefined | string

Geo paired region. NOTE: This property will not be serialized. It can only be populated by the server.

Optional earliestRestorePoint

earliestRestorePoint: Date

Earliest restore point in time for point in time restore. NOTE: This property will not be serialized. It can only be populated by the server.

Optional failoverGroupId

failoverGroupId: undefined | string

Instance Failover Group resource identifier that this managed database belongs to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional recoverableDatabaseId

recoverableDatabaseId: undefined | string

The resource identifier of the recoverable database associated with create operation of this database.

Optional restorableDroppedDatabaseId

restorableDroppedDatabaseId: undefined | string

The restorable dropped database resource id to restore when creating this database.

Optional restorePointInTime

restorePointInTime: Date

Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

serializedName

serializedName: string = "ManagedDatabase"

Optional sourceDatabaseId

sourceDatabaseId: undefined | string

The resource identifier of the source database associated with create operation of this database.

Optional status

Status of the database. Possible values include: 'Online', 'Offline', 'Shutdown', 'Creating', 'Inaccessible', 'Updating' NOTE: This property will not be serialized. It can only be populated by the server.

Optional storageContainerSasToken

storageContainerSasToken: undefined | string

Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token.

Optional storageContainerUri

storageContainerUri: undefined | string

Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "ManagedDatabase"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

catalogCollation

catalogCollation: object

serializedName

serializedName: string = "properties.catalogCollation"

type

type: object

name

name: "String" = "String"

collation

collation: object

serializedName

serializedName: string = "properties.collation"

type

type: object

name

name: "String" = "String"

createMode

createMode: object

serializedName

serializedName: string = "properties.createMode"

type

type: object

name

name: "String" = "String"

creationDate

creationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationDate"

type

type: object

name

name: "DateTime" = "DateTime"

defaultSecondaryLocation

defaultSecondaryLocation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultSecondaryLocation"

type

type: object

name

name: "String" = "String"

earliestRestorePoint

earliestRestorePoint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.earliestRestorePoint"

type

type: object

name

name: "DateTime" = "DateTime"

failoverGroupId

failoverGroupId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.failoverGroupId"

type

type: object

name

name: "String" = "String"

recoverableDatabaseId

recoverableDatabaseId: object

serializedName

serializedName: string = "properties.recoverableDatabaseId"

type

type: object

name

name: "String" = "String"

restorableDroppedDatabaseId

restorableDroppedDatabaseId: object

serializedName

serializedName: string = "properties.restorableDroppedDatabaseId"

type

type: object

name

name: "String" = "String"

restorePointInTime

restorePointInTime: object

serializedName

serializedName: string = "properties.restorePointInTime"

type

type: object

name

name: "DateTime" = "DateTime"

sourceDatabaseId

sourceDatabaseId: object

serializedName

serializedName: string = "properties.sourceDatabaseId"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

storageContainerSasToken

storageContainerSasToken: object

serializedName

serializedName: string = "properties.storageContainerSasToken"

type

type: object

name

name: "String" = "String"

storageContainerUri

storageContainerUri: object

serializedName

serializedName: string = "properties.storageContainerUri"

type

type: object

name

name: "String" = "String"

Const ManagedDatabaseListResult

ManagedDatabaseListResult: object
interface

A list of managed databases.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedDatabaseListResult"

__@iterator

  • __@iterator(): IterableIterator<ManagedDatabase>
  • Iterator

    Returns IterableIterator<ManagedDatabase>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ManagedDatabase>[]): ManagedDatabase[]
  • concat(...items: (T | ConcatArray<T>)[]): ManagedDatabase[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ManagedDatabase>[]

      Additional items to add to the end of array1.

    Returns ManagedDatabase[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ManagedDatabase[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ManagedDatabase]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ManagedDatabase]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ManagedDatabase, index: number, array: ManagedDatabase[]): boolean
        • Parameters

          • value: ManagedDatabase
          • index: number
          • array: ManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ManagedDatabase, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ManagedDatabase

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ManagedDatabase[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ManagedDatabase

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedDatabase, index: number, array: ManagedDatabase[]): boolean
        • Parameters

          • value: ManagedDatabase
          • index: number
          • array: ManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedDatabase, index: number, array: ManagedDatabase[]): any
        • Parameters

          • value: ManagedDatabase
          • index: number
          • array: ManagedDatabase[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ManagedDatabase[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ManagedDatabase | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ManagedDatabase

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ManagedDatabase, index: number, obj: ManagedDatabase[]): boolean
        • Parameters

          • this: void
          • value: ManagedDatabase
          • index: number
          • obj: ManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ManagedDatabase, index: number, obj: ManagedDatabase[]): boolean
        • Parameters

          • value: ManagedDatabase
          • index: number
          • obj: ManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

    Returns ManagedDatabase | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ManagedDatabase, index: number, obj: ManagedDatabase[]): boolean
        • Parameters

          • value: ManagedDatabase
          • index: number
          • obj: ManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ManagedDatabase, index: number, array: ManagedDatabase[]): void
        • Parameters

          • value: ManagedDatabase
          • index: number
          • array: ManagedDatabase[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ManagedDatabase, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ManagedDatabase

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ManagedDatabase, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ManagedDatabase

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ManagedDatabase, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ManagedDatabase

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ManagedDatabase, index: number, array: ManagedDatabase[]): U
        • Parameters

          • value: ManagedDatabase
          • index: number
          • array: ManagedDatabase[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ManagedDatabase | undefined
  • Removes the last element from an array and returns it.

    Returns ManagedDatabase | undefined

push

  • push(...items: ManagedDatabase[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ManagedDatabase[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ManagedDatabase
  • reduce(callbackfn: function, initialValue: ManagedDatabase): ManagedDatabase
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedDatabase, currentValue: ManagedDatabase, currentIndex: number, array: ManagedDatabase[]): ManagedDatabase
        • Parameters

          • previousValue: ManagedDatabase
          • currentValue: ManagedDatabase
          • currentIndex: number
          • array: ManagedDatabase[]

          Returns ManagedDatabase

    Returns ManagedDatabase

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedDatabase, currentValue: ManagedDatabase, currentIndex: number, array: ManagedDatabase[]): ManagedDatabase
        • Parameters

          • previousValue: ManagedDatabase
          • currentValue: ManagedDatabase
          • currentIndex: number
          • array: ManagedDatabase[]

          Returns ManagedDatabase

    • initialValue: ManagedDatabase

    Returns ManagedDatabase

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedDatabase, currentIndex: number, array: ManagedDatabase[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedDatabase
          • currentIndex: number
          • array: ManagedDatabase[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ManagedDatabase
  • reduceRight(callbackfn: function, initialValue: ManagedDatabase): ManagedDatabase
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedDatabase, currentValue: ManagedDatabase, currentIndex: number, array: ManagedDatabase[]): ManagedDatabase
        • Parameters

          • previousValue: ManagedDatabase
          • currentValue: ManagedDatabase
          • currentIndex: number
          • array: ManagedDatabase[]

          Returns ManagedDatabase

    Returns ManagedDatabase

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedDatabase, currentValue: ManagedDatabase, currentIndex: number, array: ManagedDatabase[]): ManagedDatabase
        • Parameters

          • previousValue: ManagedDatabase
          • currentValue: ManagedDatabase
          • currentIndex: number
          • array: ManagedDatabase[]

          Returns ManagedDatabase

    • initialValue: ManagedDatabase

    Returns ManagedDatabase

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedDatabase, currentIndex: number, array: ManagedDatabase[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedDatabase
          • currentIndex: number
          • array: ManagedDatabase[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ManagedDatabase[]
  • Reverses the elements in an Array.

    Returns ManagedDatabase[]

shift

  • shift(): ManagedDatabase | undefined
  • Removes the first element from an array and returns it.

    Returns ManagedDatabase | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ManagedDatabase[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ManagedDatabase[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ManagedDatabase, index: number, array: ManagedDatabase[]): boolean
        • Parameters

          • value: ManagedDatabase
          • index: number
          • array: ManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ManagedDatabase[]
  • splice(start: number, deleteCount: number, ...items: ManagedDatabase[]): ManagedDatabase[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ManagedDatabase[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ManagedDatabase[]

      Elements to insert into the array in place of the deleted elements.

    Returns ManagedDatabase[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ManagedDatabase[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ManagedDatabase[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ManagedDatabase>
  • Returns an iterable of values in the array

    Returns IterableIterator<ManagedDatabase>

type

type: object

className

className: string = "ManagedDatabaseListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedDatabase"

name

name: "Composite" = "Composite"

Const ManagedDatabaseSecurityAlertPolicy

ManagedDatabaseSecurityAlertPolicy: object

A managed database security alert policy.

Optional creationTime

creationTime: Date

Specifies the UTC creation time of the policy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional disabledAlerts

disabledAlerts: string[]

Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action

Optional emailAccountAdmins

emailAccountAdmins: undefined | false | true

Specifies that the alert is sent to the account administrators.

Optional emailAddresses

emailAddresses: string[]

Specifies an array of e-mail addresses to which the alert is sent.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional retentionDays

retentionDays: undefined | number

Specifies the number of days to keep in the Threat Detection audit logs.

serializedName

serializedName: string = "ManagedDatabaseSecurityAlertPolicy"

state

Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. Possible values include: 'New', 'Enabled', 'Disabled'

Optional storageAccountAccessKey

storageAccountAccessKey: undefined | string

Specifies the identifier key of the Threat Detection audit storage account.

Optional storageEndpoint

storageEndpoint: undefined | string

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

type

type: object

className

className: string = "ManagedDatabaseSecurityAlertPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

disabledAlerts

disabledAlerts: object

serializedName

serializedName: string = "properties.disabledAlerts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

emailAccountAdmins

emailAccountAdmins: object

serializedName

serializedName: string = "properties.emailAccountAdmins"

type

type: object

name

name: "Boolean" = "Boolean"

emailAddresses

emailAddresses: object

serializedName

serializedName: string = "properties.emailAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

retentionDays

retentionDays: object

serializedName

serializedName: string = "properties.retentionDays"

type

type: object

name

name: "Number" = "Number"

state

state: object

required

required: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["New","Enabled","Disabled"]

name

name: "Enum" = "Enum"

storageAccountAccessKey

storageAccountAccessKey: object

serializedName

serializedName: string = "properties.storageAccountAccessKey"

type

type: object

name

name: "String" = "String"

storageEndpoint

storageEndpoint: object

serializedName

serializedName: string = "properties.storageEndpoint"

type

type: object

name

name: "String" = "String"

Const ManagedDatabaseSecurityAlertPolicyListResult

ManagedDatabaseSecurityAlertPolicyListResult: object
interface

A list of the managed database's security alert policies.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedDatabaseSecurityAlertPolicyListResult"

__@iterator

  • __@iterator(): IterableIterator<ManagedDatabaseSecurityAlertPolicy>
  • Iterator

    Returns IterableIterator<ManagedDatabaseSecurityAlertPolicy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ManagedDatabaseSecurityAlertPolicy>[]): ManagedDatabaseSecurityAlertPolicy[]
  • concat(...items: (T | ConcatArray<T>)[]): ManagedDatabaseSecurityAlertPolicy[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ManagedDatabaseSecurityAlertPolicy>[]

      Additional items to add to the end of array1.

    Returns ManagedDatabaseSecurityAlertPolicy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ManagedDatabaseSecurityAlertPolicy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ManagedDatabaseSecurityAlertPolicy]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ManagedDatabaseSecurityAlertPolicy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ManagedDatabaseSecurityAlertPolicy, index: number, array: ManagedDatabaseSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ManagedDatabaseSecurityAlertPolicy
          • index: number
          • array: ManagedDatabaseSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ManagedDatabaseSecurityAlertPolicy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ManagedDatabaseSecurityAlertPolicy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ManagedDatabaseSecurityAlertPolicy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ManagedDatabaseSecurityAlertPolicy

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedDatabaseSecurityAlertPolicy, index: number, array: ManagedDatabaseSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ManagedDatabaseSecurityAlertPolicy
          • index: number
          • array: ManagedDatabaseSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedDatabaseSecurityAlertPolicy, index: number, array: ManagedDatabaseSecurityAlertPolicy[]): any
        • Parameters

          • value: ManagedDatabaseSecurityAlertPolicy
          • index: number
          • array: ManagedDatabaseSecurityAlertPolicy[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ManagedDatabaseSecurityAlertPolicy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ManagedDatabaseSecurityAlertPolicy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ManagedDatabaseSecurityAlertPolicy

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ManagedDatabaseSecurityAlertPolicy, index: number, obj: ManagedDatabaseSecurityAlertPolicy[]): boolean
        • Parameters

          • this: void
          • value: ManagedDatabaseSecurityAlertPolicy
          • index: number
          • obj: ManagedDatabaseSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ManagedDatabaseSecurityAlertPolicy, index: number, obj: ManagedDatabaseSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ManagedDatabaseSecurityAlertPolicy
          • index: number
          • obj: ManagedDatabaseSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

    Returns ManagedDatabaseSecurityAlertPolicy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ManagedDatabaseSecurityAlertPolicy, index: number, obj: ManagedDatabaseSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ManagedDatabaseSecurityAlertPolicy
          • index: number
          • obj: ManagedDatabaseSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ManagedDatabaseSecurityAlertPolicy, index: number, array: ManagedDatabaseSecurityAlertPolicy[]): void
        • Parameters

          • value: ManagedDatabaseSecurityAlertPolicy
          • index: number
          • array: ManagedDatabaseSecurityAlertPolicy[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ManagedDatabaseSecurityAlertPolicy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ManagedDatabaseSecurityAlertPolicy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ManagedDatabaseSecurityAlertPolicy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ManagedDatabaseSecurityAlertPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ManagedDatabaseSecurityAlertPolicy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ManagedDatabaseSecurityAlertPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ManagedDatabaseSecurityAlertPolicy, index: number, array: ManagedDatabaseSecurityAlertPolicy[]): U
        • Parameters

          • value: ManagedDatabaseSecurityAlertPolicy
          • index: number
          • array: ManagedDatabaseSecurityAlertPolicy[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ManagedDatabaseSecurityAlertPolicy | undefined
  • Removes the last element from an array and returns it.

    Returns ManagedDatabaseSecurityAlertPolicy | undefined

push

  • push(...items: ManagedDatabaseSecurityAlertPolicy[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ManagedDatabaseSecurityAlertPolicy[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ManagedDatabaseSecurityAlertPolicy
  • reduce(callbackfn: function, initialValue: ManagedDatabaseSecurityAlertPolicy): ManagedDatabaseSecurityAlertPolicy
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedDatabaseSecurityAlertPolicy, currentValue: ManagedDatabaseSecurityAlertPolicy, currentIndex: number, array: ManagedDatabaseSecurityAlertPolicy[]): ManagedDatabaseSecurityAlertPolicy
        • Parameters

          • previousValue: ManagedDatabaseSecurityAlertPolicy
          • currentValue: ManagedDatabaseSecurityAlertPolicy
          • currentIndex: number
          • array: ManagedDatabaseSecurityAlertPolicy[]

          Returns ManagedDatabaseSecurityAlertPolicy

    Returns ManagedDatabaseSecurityAlertPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedDatabaseSecurityAlertPolicy, currentValue: ManagedDatabaseSecurityAlertPolicy, currentIndex: number, array: ManagedDatabaseSecurityAlertPolicy[]): ManagedDatabaseSecurityAlertPolicy
        • Parameters

          • previousValue: ManagedDatabaseSecurityAlertPolicy
          • currentValue: ManagedDatabaseSecurityAlertPolicy
          • currentIndex: number
          • array: ManagedDatabaseSecurityAlertPolicy[]

          Returns ManagedDatabaseSecurityAlertPolicy

    • initialValue: ManagedDatabaseSecurityAlertPolicy

    Returns ManagedDatabaseSecurityAlertPolicy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedDatabaseSecurityAlertPolicy, currentIndex: number, array: ManagedDatabaseSecurityAlertPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedDatabaseSecurityAlertPolicy
          • currentIndex: number
          • array: ManagedDatabaseSecurityAlertPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ManagedDatabaseSecurityAlertPolicy
  • reduceRight(callbackfn: function, initialValue: ManagedDatabaseSecurityAlertPolicy): ManagedDatabaseSecurityAlertPolicy
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedDatabaseSecurityAlertPolicy, currentValue: ManagedDatabaseSecurityAlertPolicy, currentIndex: number, array: ManagedDatabaseSecurityAlertPolicy[]): ManagedDatabaseSecurityAlertPolicy
        • Parameters

          • previousValue: ManagedDatabaseSecurityAlertPolicy
          • currentValue: ManagedDatabaseSecurityAlertPolicy
          • currentIndex: number
          • array: ManagedDatabaseSecurityAlertPolicy[]

          Returns ManagedDatabaseSecurityAlertPolicy

    Returns ManagedDatabaseSecurityAlertPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedDatabaseSecurityAlertPolicy, currentValue: ManagedDatabaseSecurityAlertPolicy, currentIndex: number, array: ManagedDatabaseSecurityAlertPolicy[]): ManagedDatabaseSecurityAlertPolicy
        • Parameters

          • previousValue: ManagedDatabaseSecurityAlertPolicy
          • currentValue: ManagedDatabaseSecurityAlertPolicy
          • currentIndex: number
          • array: ManagedDatabaseSecurityAlertPolicy[]

          Returns ManagedDatabaseSecurityAlertPolicy

    • initialValue: ManagedDatabaseSecurityAlertPolicy

    Returns ManagedDatabaseSecurityAlertPolicy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedDatabaseSecurityAlertPolicy, currentIndex: number, array: ManagedDatabaseSecurityAlertPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedDatabaseSecurityAlertPolicy
          • currentIndex: number
          • array: ManagedDatabaseSecurityAlertPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ManagedDatabaseSecurityAlertPolicy[]
  • Reverses the elements in an Array.

    Returns ManagedDatabaseSecurityAlertPolicy[]

shift

  • shift(): ManagedDatabaseSecurityAlertPolicy | undefined
  • Removes the first element from an array and returns it.

    Returns ManagedDatabaseSecurityAlertPolicy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ManagedDatabaseSecurityAlertPolicy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ManagedDatabaseSecurityAlertPolicy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ManagedDatabaseSecurityAlertPolicy, index: number, array: ManagedDatabaseSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ManagedDatabaseSecurityAlertPolicy
          • index: number
          • array: ManagedDatabaseSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ManagedDatabaseSecurityAlertPolicy[]
  • splice(start: number, deleteCount: number, ...items: ManagedDatabaseSecurityAlertPolicy[]): ManagedDatabaseSecurityAlertPolicy[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ManagedDatabaseSecurityAlertPolicy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ManagedDatabaseSecurityAlertPolicy[]

      Elements to insert into the array in place of the deleted elements.

    Returns ManagedDatabaseSecurityAlertPolicy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ManagedDatabaseSecurityAlertPolicy[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ManagedDatabaseSecurityAlertPolicy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ManagedDatabaseSecurityAlertPolicy>
  • Returns an iterable of values in the array

    Returns IterableIterator<ManagedDatabaseSecurityAlertPolicy>

type

type: object

className

className: string = "ManagedDatabaseSecurityAlertPolicyListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedDatabaseSecurityAlertPolicy"

name

name: "Composite" = "Composite"

Const ManagedDatabaseUpdate

ManagedDatabaseUpdate: object

An managed database update.

Optional catalogCollation

catalogCollation: CatalogCollationType

Collation of the metadata catalog. Possible values include: 'DATABASE_DEFAULT', 'SQL_Latin1_General_CP1_CI_AS'

Optional collation

collation: undefined | string

Collation of the managed database.

Optional createMode

Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. Possible values include: 'Default', 'RestoreExternalBackup', 'PointInTimeRestore', 'Recovery'

Optional creationDate

creationDate: Date

Creation date of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultSecondaryLocation

defaultSecondaryLocation: undefined | string

Geo paired region. NOTE: This property will not be serialized. It can only be populated by the server.

Optional earliestRestorePoint

earliestRestorePoint: Date

Earliest restore point in time for point in time restore. NOTE: This property will not be serialized. It can only be populated by the server.

Optional failoverGroupId

failoverGroupId: undefined | string

Instance Failover Group resource identifier that this managed database belongs to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional recoverableDatabaseId

recoverableDatabaseId: undefined | string

The resource identifier of the recoverable database associated with create operation of this database.

Optional restorableDroppedDatabaseId

restorableDroppedDatabaseId: undefined | string

The restorable dropped database resource id to restore when creating this database.

Optional restorePointInTime

restorePointInTime: Date

Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

serializedName

serializedName: string = "ManagedDatabaseUpdate"

Optional sourceDatabaseId

sourceDatabaseId: undefined | string

The resource identifier of the source database associated with create operation of this database.

Optional status

Status of the database. Possible values include: 'Online', 'Offline', 'Shutdown', 'Creating', 'Inaccessible', 'Updating' NOTE: This property will not be serialized. It can only be populated by the server.

Optional storageContainerSasToken

storageContainerSasToken: undefined | string

Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token.

Optional storageContainerUri

storageContainerUri: undefined | string

Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "ManagedDatabaseUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

catalogCollation

catalogCollation: object

serializedName

serializedName: string = "properties.catalogCollation"

type

type: object

name

name: "String" = "String"

collation

collation: object

serializedName

serializedName: string = "properties.collation"

type

type: object

name

name: "String" = "String"

createMode

createMode: object

serializedName

serializedName: string = "properties.createMode"

type

type: object

name

name: "String" = "String"

creationDate

creationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationDate"

type

type: object

name

name: "DateTime" = "DateTime"

defaultSecondaryLocation

defaultSecondaryLocation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultSecondaryLocation"

type

type: object

name

name: "String" = "String"

earliestRestorePoint

earliestRestorePoint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.earliestRestorePoint"

type

type: object

name

name: "DateTime" = "DateTime"

failoverGroupId

failoverGroupId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.failoverGroupId"

type

type: object

name

name: "String" = "String"

recoverableDatabaseId

recoverableDatabaseId: object

serializedName

serializedName: string = "properties.recoverableDatabaseId"

type

type: object

name

name: "String" = "String"

restorableDroppedDatabaseId

restorableDroppedDatabaseId: object

serializedName

serializedName: string = "properties.restorableDroppedDatabaseId"

type

type: object

name

name: "String" = "String"

restorePointInTime

restorePointInTime: object

serializedName

serializedName: string = "properties.restorePointInTime"

type

type: object

name

name: "DateTime" = "DateTime"

sourceDatabaseId

sourceDatabaseId: object

serializedName

serializedName: string = "properties.sourceDatabaseId"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

storageContainerSasToken

storageContainerSasToken: object

serializedName

serializedName: string = "properties.storageContainerSasToken"

type

type: object

name

name: "String" = "String"

storageContainerUri

storageContainerUri: object

serializedName

serializedName: string = "properties.storageContainerUri"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const ManagedInstance

ManagedInstance: object

An Azure SQL managed instance.

Optional administratorLogin

administratorLogin: undefined | string

Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).

Optional administratorLoginPassword

administratorLoginPassword: undefined | string

The administrator login password (required for managed instance creation).

Optional collation

collation: undefined | string

Collation of the managed instance.

Optional dnsZone

dnsZone: undefined | string

The Dns Zone that the managed instance is in. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dnsZonePartner

dnsZonePartner: undefined | string

The resource id of another managed instance whose DNS zone this managed instance will share after creation.

Optional fullyQualifiedDomainName

fullyQualifiedDomainName: undefined | string

The fully qualified domain name of the managed instance. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

The Azure Active Directory identity of the managed instance.

Optional licenseType

licenseType: undefined | string

The license type. Possible values are 'LicenseIncluded' and 'BasePrice'.

location

location: string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional proxyOverride

Connection type used for connecting to the instance. Possible values include: 'Proxy', 'Redirect', 'Default'

Optional publicDataEndpointEnabled

publicDataEndpointEnabled: undefined | false | true

Whether or not the public data endpoint is enabled.

serializedName

serializedName: string = "ManagedInstance"

Optional sku

sku: Sku

Managed instance sku

Optional state

state: undefined | string

The state of the managed instance. NOTE: This property will not be serialized. It can only be populated by the server.

Optional storageSizeInGB

storageSizeInGB: undefined | number

The maximum storage size in GB.

Optional subnetId

subnetId: undefined | string

Subnet resource ID for the managed instance.

Optional tags

tags: undefined | object

Resource tags.

Optional timezoneId

timezoneId: undefined | string

Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time".

Optional vCores

vCores: undefined | number

The number of VCores.

type

type: object

className

className: string = "ManagedInstance"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

administratorLogin

administratorLogin: object

serializedName

serializedName: string = "properties.administratorLogin"

type

type: object

name

name: "String" = "String"

administratorLoginPassword

administratorLoginPassword: object

serializedName

serializedName: string = "properties.administratorLoginPassword"

type

type: object

name

name: "String" = "String"

collation

collation: object

serializedName

serializedName: string = "properties.collation"

type

type: object

name

name: "String" = "String"

dnsZone

dnsZone: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.dnsZone"

type

type: object

name

name: "String" = "String"

dnsZonePartner

dnsZonePartner: object

serializedName

serializedName: string = "properties.dnsZonePartner"

type

type: object

name

name: "String" = "String"

fullyQualifiedDomainName

fullyQualifiedDomainName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.fullyQualifiedDomainName"

type

type: object

name

name: "String" = "String"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "ResourceIdentity"

name

name: "Composite" = "Composite"

licenseType

licenseType: object

serializedName

serializedName: string = "properties.licenseType"

type

type: object

name

name: "String" = "String"

proxyOverride

proxyOverride: object

serializedName

serializedName: string = "properties.proxyOverride"

type

type: object

name

name: "String" = "String"

publicDataEndpointEnabled

publicDataEndpointEnabled: object

serializedName

serializedName: string = "properties.publicDataEndpointEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

storageSizeInGB

storageSizeInGB: object

serializedName

serializedName: string = "properties.storageSizeInGB"

type

type: object

name

name: "Number" = "Number"

subnetId

subnetId: object

serializedName

serializedName: string = "properties.subnetId"

type

type: object

name

name: "String" = "String"

timezoneId

timezoneId: object

serializedName

serializedName: string = "properties.timezoneId"

type

type: object

name

name: "String" = "String"

vCores

vCores: object

serializedName

serializedName: string = "properties.vCores"

type

type: object

name

name: "Number" = "Number"

Const ManagedInstanceEditionCapability

ManagedInstanceEditionCapability: object

The managed server capability

Optional name

name: undefined | string

The managed server version name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "ManagedInstanceEditionCapability"

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedFamilies

supportedFamilies: ManagedInstanceFamilyCapability[]

The supported families. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ManagedInstanceEditionCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

supportedFamilies

supportedFamilies: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedFamilies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedInstanceFamilyCapability"

name

name: "Composite" = "Composite"

Const ManagedInstanceEncryptionProtector

ManagedInstanceEncryptionProtector: object

The managed instance encryption protector.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of encryption protector. This is metadata used for the Azure portal experience. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedInstanceEncryptionProtector"

Optional serverKeyName

serverKeyName: undefined | string

The name of the managed instance key.

serverKeyType

serverKeyType: ServerKeyType

The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. Possible values include: 'ServiceManaged', 'AzureKeyVault'

Optional thumbprint

thumbprint: undefined | string

Thumbprint of the server key. NOTE: This property will not be serialized. It can only be populated by the server.

Optional uri

uri: undefined | string

The URI of the server key. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ManagedInstanceEncryptionProtector"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

serverKeyName

serverKeyName: object

serializedName

serializedName: string = "properties.serverKeyName"

type

type: object

name

name: "String" = "String"

serverKeyType

serverKeyType: object

required

required: true = true

serializedName

serializedName: string = "properties.serverKeyType"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

uri

uri: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uri"

type

type: object

name

name: "String" = "String"

Const ManagedInstanceEncryptionProtectorListResult

ManagedInstanceEncryptionProtectorListResult: object
interface

A list of managed instance encryption protectors.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedInstanceEncryptionProtectorListResult"

__@iterator

  • __@iterator(): IterableIterator<ManagedInstanceEncryptionProtector>
  • Iterator

    Returns IterableIterator<ManagedInstanceEncryptionProtector>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ManagedInstanceEncryptionProtector>[]): ManagedInstanceEncryptionProtector[]
  • concat(...items: (T | ConcatArray<T>)[]): ManagedInstanceEncryptionProtector[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ManagedInstanceEncryptionProtector>[]

      Additional items to add to the end of array1.

    Returns ManagedInstanceEncryptionProtector[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ManagedInstanceEncryptionProtector[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ManagedInstanceEncryptionProtector]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ManagedInstanceEncryptionProtector]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ManagedInstanceEncryptionProtector, index: number, array: ManagedInstanceEncryptionProtector[]): boolean
        • Parameters

          • value: ManagedInstanceEncryptionProtector
          • index: number
          • array: ManagedInstanceEncryptionProtector[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ManagedInstanceEncryptionProtector, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ManagedInstanceEncryptionProtector

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ManagedInstanceEncryptionProtector[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ManagedInstanceEncryptionProtector

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstanceEncryptionProtector, index: number, array: ManagedInstanceEncryptionProtector[]): boolean
        • Parameters

          • value: ManagedInstanceEncryptionProtector
          • index: number
          • array: ManagedInstanceEncryptionProtector[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstanceEncryptionProtector, index: number, array: ManagedInstanceEncryptionProtector[]): any
        • Parameters

          • value: ManagedInstanceEncryptionProtector
          • index: number
          • array: ManagedInstanceEncryptionProtector[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ManagedInstanceEncryptionProtector[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ManagedInstanceEncryptionProtector | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ManagedInstanceEncryptionProtector

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ManagedInstanceEncryptionProtector, index: number, obj: ManagedInstanceEncryptionProtector[]): boolean
        • Parameters

          • this: void
          • value: ManagedInstanceEncryptionProtector
          • index: number
          • obj: ManagedInstanceEncryptionProtector[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ManagedInstanceEncryptionProtector, index: number, obj: ManagedInstanceEncryptionProtector[]): boolean
        • Parameters

          • value: ManagedInstanceEncryptionProtector
          • index: number
          • obj: ManagedInstanceEncryptionProtector[]

          Returns boolean

    • Optional thisArg: any

    Returns ManagedInstanceEncryptionProtector | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ManagedInstanceEncryptionProtector, index: number, obj: ManagedInstanceEncryptionProtector[]): boolean
        • Parameters

          • value: ManagedInstanceEncryptionProtector
          • index: number
          • obj: ManagedInstanceEncryptionProtector[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstanceEncryptionProtector, index: number, array: ManagedInstanceEncryptionProtector[]): void
        • Parameters

          • value: ManagedInstanceEncryptionProtector
          • index: number
          • array: ManagedInstanceEncryptionProtector[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ManagedInstanceEncryptionProtector, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ManagedInstanceEncryptionProtector

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ManagedInstanceEncryptionProtector, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ManagedInstanceEncryptionProtector

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ManagedInstanceEncryptionProtector, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ManagedInstanceEncryptionProtector

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstanceEncryptionProtector, index: number, array: ManagedInstanceEncryptionProtector[]): U
        • Parameters

          • value: ManagedInstanceEncryptionProtector
          • index: number
          • array: ManagedInstanceEncryptionProtector[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ManagedInstanceEncryptionProtector | undefined
  • Removes the last element from an array and returns it.

    Returns ManagedInstanceEncryptionProtector | undefined

push

  • push(...items: ManagedInstanceEncryptionProtector[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ManagedInstanceEncryptionProtector[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ManagedInstanceEncryptionProtector
  • reduce(callbackfn: function, initialValue: ManagedInstanceEncryptionProtector): ManagedInstanceEncryptionProtector
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedInstanceEncryptionProtector, currentValue: ManagedInstanceEncryptionProtector, currentIndex: number, array: ManagedInstanceEncryptionProtector[]): ManagedInstanceEncryptionProtector
        • Parameters

          • previousValue: ManagedInstanceEncryptionProtector
          • currentValue: ManagedInstanceEncryptionProtector
          • currentIndex: number
          • array: ManagedInstanceEncryptionProtector[]

          Returns ManagedInstanceEncryptionProtector

    Returns ManagedInstanceEncryptionProtector

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedInstanceEncryptionProtector, currentValue: ManagedInstanceEncryptionProtector, currentIndex: number, array: ManagedInstanceEncryptionProtector[]): ManagedInstanceEncryptionProtector
        • Parameters

          • previousValue: ManagedInstanceEncryptionProtector
          • currentValue: ManagedInstanceEncryptionProtector
          • currentIndex: number
          • array: ManagedInstanceEncryptionProtector[]

          Returns ManagedInstanceEncryptionProtector

    • initialValue: ManagedInstanceEncryptionProtector

    Returns ManagedInstanceEncryptionProtector

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedInstanceEncryptionProtector, currentIndex: number, array: ManagedInstanceEncryptionProtector[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedInstanceEncryptionProtector
          • currentIndex: number
          • array: ManagedInstanceEncryptionProtector[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ManagedInstanceEncryptionProtector
  • reduceRight(callbackfn: function, initialValue: ManagedInstanceEncryptionProtector): ManagedInstanceEncryptionProtector
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedInstanceEncryptionProtector, currentValue: ManagedInstanceEncryptionProtector, currentIndex: number, array: ManagedInstanceEncryptionProtector[]): ManagedInstanceEncryptionProtector
        • Parameters

          • previousValue: ManagedInstanceEncryptionProtector
          • currentValue: ManagedInstanceEncryptionProtector
          • currentIndex: number
          • array: ManagedInstanceEncryptionProtector[]

          Returns ManagedInstanceEncryptionProtector

    Returns ManagedInstanceEncryptionProtector

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedInstanceEncryptionProtector, currentValue: ManagedInstanceEncryptionProtector, currentIndex: number, array: ManagedInstanceEncryptionProtector[]): ManagedInstanceEncryptionProtector
        • Parameters

          • previousValue: ManagedInstanceEncryptionProtector
          • currentValue: ManagedInstanceEncryptionProtector
          • currentIndex: number
          • array: ManagedInstanceEncryptionProtector[]

          Returns ManagedInstanceEncryptionProtector

    • initialValue: ManagedInstanceEncryptionProtector

    Returns ManagedInstanceEncryptionProtector

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedInstanceEncryptionProtector, currentIndex: number, array: ManagedInstanceEncryptionProtector[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedInstanceEncryptionProtector
          • currentIndex: number
          • array: ManagedInstanceEncryptionProtector[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ManagedInstanceEncryptionProtector[]
  • Reverses the elements in an Array.

    Returns ManagedInstanceEncryptionProtector[]

shift

  • shift(): ManagedInstanceEncryptionProtector | undefined
  • Removes the first element from an array and returns it.

    Returns ManagedInstanceEncryptionProtector | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ManagedInstanceEncryptionProtector[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ManagedInstanceEncryptionProtector[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ManagedInstanceEncryptionProtector, index: number, array: ManagedInstanceEncryptionProtector[]): boolean
        • Parameters

          • value: ManagedInstanceEncryptionProtector
          • index: number
          • array: ManagedInstanceEncryptionProtector[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ManagedInstanceEncryptionProtector[]
  • splice(start: number, deleteCount: number, ...items: ManagedInstanceEncryptionProtector[]): ManagedInstanceEncryptionProtector[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ManagedInstanceEncryptionProtector[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ManagedInstanceEncryptionProtector[]

      Elements to insert into the array in place of the deleted elements.

    Returns ManagedInstanceEncryptionProtector[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ManagedInstanceEncryptionProtector[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ManagedInstanceEncryptionProtector[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ManagedInstanceEncryptionProtector>
  • Returns an iterable of values in the array

    Returns IterableIterator<ManagedInstanceEncryptionProtector>

type

type: object

className

className: string = "ManagedInstanceEncryptionProtectorListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedInstanceEncryptionProtector"

name

name: "Composite" = "Composite"

Const ManagedInstanceFamilyCapability

ManagedInstanceFamilyCapability: object

The managed server family capability.

Optional includedMaxSize

includedMaxSize: MaxSizeCapability

Included size. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Family name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "ManagedInstanceFamilyCapability"

Optional sku

sku: undefined | string

SKU name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedLicenseTypes

supportedLicenseTypes: LicenseTypeCapability[]

List of supported license types. NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedStorageSizes

supportedStorageSizes: MaxSizeRangeCapability[]

Storage size ranges. NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedVcoresValues

supportedVcoresValues: ManagedInstanceVcoresCapability[]

List of supported virtual cores values. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ManagedInstanceFamilyCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

includedMaxSize

includedMaxSize: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "includedMaxSize"

type

type: object

className

className: string = "MaxSizeCapability"

name

name: "Composite" = "Composite"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

sku

sku: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "sku"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

supportedLicenseTypes

supportedLicenseTypes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedLicenseTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LicenseTypeCapability"

name

name: "Composite" = "Composite"

supportedStorageSizes

supportedStorageSizes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedStorageSizes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MaxSizeRangeCapability"

name

name: "Composite" = "Composite"

supportedVcoresValues

supportedVcoresValues: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedVcoresValues"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedInstanceVcoresCapability"

name

name: "Composite" = "Composite"

Const ManagedInstanceKey

ManagedInstanceKey: object

A managed instance key.

Optional creationDate

creationDate: Date

The key creation date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of encryption protector. This is metadata used for the Azure portal experience. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedInstanceKey"

serverKeyType

serverKeyType: ServerKeyType

The key type like 'ServiceManaged', 'AzureKeyVault'. Possible values include: 'ServiceManaged', 'AzureKeyVault'

Optional thumbprint

thumbprint: undefined | string

Thumbprint of the key. NOTE: This property will not be serialized. It can only be populated by the server.

Optional uri

uri: undefined | string

The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.

type

type: object

className

className: string = "ManagedInstanceKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationDate

creationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationDate"

type

type: object

name

name: "DateTime" = "DateTime"

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

serverKeyType

serverKeyType: object

required

required: true = true

serializedName

serializedName: string = "properties.serverKeyType"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

uri

uri: object

serializedName

serializedName: string = "properties.uri"

type

type: object

name

name: "String" = "String"

Const ManagedInstanceKeyListResult

ManagedInstanceKeyListResult: object
interface

A list of managed instance keys.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedInstanceKeyListResult"

__@iterator

  • __@iterator(): IterableIterator<ManagedInstanceKey>
  • Iterator

    Returns IterableIterator<ManagedInstanceKey>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ManagedInstanceKey>[]): ManagedInstanceKey[]
  • concat(...items: (T | ConcatArray<T>)[]): ManagedInstanceKey[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ManagedInstanceKey>[]

      Additional items to add to the end of array1.

    Returns ManagedInstanceKey[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ManagedInstanceKey[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ManagedInstanceKey]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ManagedInstanceKey]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ManagedInstanceKey, index: number, array: ManagedInstanceKey[]): boolean
        • Parameters

          • value: ManagedInstanceKey
          • index: number
          • array: ManagedInstanceKey[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ManagedInstanceKey, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ManagedInstanceKey

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ManagedInstanceKey[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ManagedInstanceKey

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstanceKey, index: number, array: ManagedInstanceKey[]): boolean
        • Parameters

          • value: ManagedInstanceKey
          • index: number
          • array: ManagedInstanceKey[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstanceKey, index: number, array: ManagedInstanceKey[]): any
        • Parameters

          • value: ManagedInstanceKey
          • index: number
          • array: ManagedInstanceKey[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ManagedInstanceKey[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ManagedInstanceKey | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ManagedInstanceKey

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ManagedInstanceKey, index: number, obj: ManagedInstanceKey[]): boolean
        • Parameters

          • this: void
          • value: ManagedInstanceKey
          • index: number
          • obj: ManagedInstanceKey[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ManagedInstanceKey, index: number, obj: ManagedInstanceKey[]): boolean
        • Parameters

          • value: ManagedInstanceKey
          • index: number
          • obj: ManagedInstanceKey[]

          Returns boolean

    • Optional thisArg: any

    Returns ManagedInstanceKey | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ManagedInstanceKey, index: number, obj: ManagedInstanceKey[]): boolean
        • Parameters

          • value: ManagedInstanceKey
          • index: number
          • obj: ManagedInstanceKey[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstanceKey, index: number, array: ManagedInstanceKey[]): void
        • Parameters

          • value: ManagedInstanceKey
          • index: number
          • array: ManagedInstanceKey[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ManagedInstanceKey, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ManagedInstanceKey

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ManagedInstanceKey, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ManagedInstanceKey

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ManagedInstanceKey, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ManagedInstanceKey

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstanceKey, index: number, array: ManagedInstanceKey[]): U
        • Parameters

          • value: ManagedInstanceKey
          • index: number
          • array: ManagedInstanceKey[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ManagedInstanceKey | undefined
  • Removes the last element from an array and returns it.

    Returns ManagedInstanceKey | undefined

push

  • push(...items: ManagedInstanceKey[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ManagedInstanceKey[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ManagedInstanceKey
  • reduce(callbackfn: function, initialValue: ManagedInstanceKey): ManagedInstanceKey
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedInstanceKey, currentValue: ManagedInstanceKey, currentIndex: number, array: ManagedInstanceKey[]): ManagedInstanceKey
        • Parameters

          • previousValue: ManagedInstanceKey
          • currentValue: ManagedInstanceKey
          • currentIndex: number
          • array: ManagedInstanceKey[]

          Returns ManagedInstanceKey

    Returns ManagedInstanceKey

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedInstanceKey, currentValue: ManagedInstanceKey, currentIndex: number, array: ManagedInstanceKey[]): ManagedInstanceKey
        • Parameters

          • previousValue: ManagedInstanceKey
          • currentValue: ManagedInstanceKey
          • currentIndex: number
          • array: ManagedInstanceKey[]

          Returns ManagedInstanceKey

    • initialValue: ManagedInstanceKey

    Returns ManagedInstanceKey

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedInstanceKey, currentIndex: number, array: ManagedInstanceKey[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedInstanceKey
          • currentIndex: number
          • array: ManagedInstanceKey[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ManagedInstanceKey
  • reduceRight(callbackfn: function, initialValue: ManagedInstanceKey): ManagedInstanceKey
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedInstanceKey, currentValue: ManagedInstanceKey, currentIndex: number, array: ManagedInstanceKey[]): ManagedInstanceKey
        • Parameters

          • previousValue: ManagedInstanceKey
          • currentValue: ManagedInstanceKey
          • currentIndex: number
          • array: ManagedInstanceKey[]

          Returns ManagedInstanceKey

    Returns ManagedInstanceKey

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedInstanceKey, currentValue: ManagedInstanceKey, currentIndex: number, array: ManagedInstanceKey[]): ManagedInstanceKey
        • Parameters

          • previousValue: ManagedInstanceKey
          • currentValue: ManagedInstanceKey
          • currentIndex: number
          • array: ManagedInstanceKey[]

          Returns ManagedInstanceKey

    • initialValue: ManagedInstanceKey

    Returns ManagedInstanceKey

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedInstanceKey, currentIndex: number, array: ManagedInstanceKey[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedInstanceKey
          • currentIndex: number
          • array: ManagedInstanceKey[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ManagedInstanceKey[]
  • Reverses the elements in an Array.

    Returns ManagedInstanceKey[]

shift

  • shift(): ManagedInstanceKey | undefined
  • Removes the first element from an array and returns it.

    Returns ManagedInstanceKey | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ManagedInstanceKey[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ManagedInstanceKey[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ManagedInstanceKey, index: number, array: ManagedInstanceKey[]): boolean
        • Parameters

          • value: ManagedInstanceKey
          • index: number
          • array: ManagedInstanceKey[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ManagedInstanceKey[]
  • splice(start: number, deleteCount: number, ...items: ManagedInstanceKey[]): ManagedInstanceKey[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ManagedInstanceKey[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ManagedInstanceKey[]

      Elements to insert into the array in place of the deleted elements.

    Returns ManagedInstanceKey[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ManagedInstanceKey[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ManagedInstanceKey[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ManagedInstanceKey>
  • Returns an iterable of values in the array

    Returns IterableIterator<ManagedInstanceKey>

type

type: object

className

className: string = "ManagedInstanceKeyListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedInstanceKey"

name

name: "Composite" = "Composite"

Const ManagedInstanceListResult

ManagedInstanceListResult: object
interface

A list of managed instances.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedInstanceListResult"

__@iterator

  • __@iterator(): IterableIterator<ManagedInstance>
  • Iterator

    Returns IterableIterator<ManagedInstance>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ManagedInstance>[]): ManagedInstance[]
  • concat(...items: (T | ConcatArray<T>)[]): ManagedInstance[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ManagedInstance>[]

      Additional items to add to the end of array1.

    Returns ManagedInstance[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ManagedInstance[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ManagedInstance]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ManagedInstance]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ManagedInstance, index: number, array: ManagedInstance[]): boolean
        • Parameters

          • value: ManagedInstance
          • index: number
          • array: ManagedInstance[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ManagedInstance, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ManagedInstance

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ManagedInstance[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ManagedInstance

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstance, index: number, array: ManagedInstance[]): boolean
        • Parameters

          • value: ManagedInstance
          • index: number
          • array: ManagedInstance[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstance, index: number, array: ManagedInstance[]): any
        • Parameters

          • value: ManagedInstance
          • index: number
          • array: ManagedInstance[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ManagedInstance[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ManagedInstance | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ManagedInstance

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ManagedInstance, index: number, obj: ManagedInstance[]): boolean
        • Parameters

          • this: void
          • value: ManagedInstance
          • index: number
          • obj: ManagedInstance[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ManagedInstance, index: number, obj: ManagedInstance[]): boolean
        • Parameters

          • value: ManagedInstance
          • index: number
          • obj: ManagedInstance[]

          Returns boolean

    • Optional thisArg: any

    Returns ManagedInstance | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ManagedInstance, index: number, obj: ManagedInstance[]): boolean
        • Parameters

          • value: ManagedInstance
          • index: number
          • obj: ManagedInstance[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstance, index: number, array: ManagedInstance[]): void
        • Parameters

          • value: ManagedInstance
          • index: number
          • array: ManagedInstance[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ManagedInstance, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ManagedInstance

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ManagedInstance, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ManagedInstance

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ManagedInstance, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ManagedInstance

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstance, index: number, array: ManagedInstance[]): U
        • Parameters

          • value: ManagedInstance
          • index: number
          • array: ManagedInstance[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ManagedInstance | undefined
  • Removes the last element from an array and returns it.

    Returns ManagedInstance | undefined

push

  • push(...items: ManagedInstance[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ManagedInstance[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ManagedInstance
  • reduce(callbackfn: function, initialValue: ManagedInstance): ManagedInstance
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedInstance, currentValue: ManagedInstance, currentIndex: number, array: ManagedInstance[]): ManagedInstance
        • Parameters

          • previousValue: ManagedInstance
          • currentValue: ManagedInstance
          • currentIndex: number
          • array: ManagedInstance[]

          Returns ManagedInstance

    Returns ManagedInstance

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedInstance, currentValue: ManagedInstance, currentIndex: number, array: ManagedInstance[]): ManagedInstance
        • Parameters

          • previousValue: ManagedInstance
          • currentValue: ManagedInstance
          • currentIndex: number
          • array: ManagedInstance[]

          Returns ManagedInstance

    • initialValue: ManagedInstance

    Returns ManagedInstance

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedInstance, currentIndex: number, array: ManagedInstance[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedInstance
          • currentIndex: number
          • array: ManagedInstance[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ManagedInstance
  • reduceRight(callbackfn: function, initialValue: ManagedInstance): ManagedInstance
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedInstance, currentValue: ManagedInstance, currentIndex: number, array: ManagedInstance[]): ManagedInstance
        • Parameters

          • previousValue: ManagedInstance
          • currentValue: ManagedInstance
          • currentIndex: number
          • array: ManagedInstance[]

          Returns ManagedInstance

    Returns ManagedInstance

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedInstance, currentValue: ManagedInstance, currentIndex: number, array: ManagedInstance[]): ManagedInstance
        • Parameters

          • previousValue: ManagedInstance
          • currentValue: ManagedInstance
          • currentIndex: number
          • array: ManagedInstance[]

          Returns ManagedInstance

    • initialValue: ManagedInstance

    Returns ManagedInstance

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedInstance, currentIndex: number, array: ManagedInstance[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedInstance
          • currentIndex: number
          • array: ManagedInstance[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ManagedInstance[]
  • Reverses the elements in an Array.

    Returns ManagedInstance[]

shift

  • shift(): ManagedInstance | undefined
  • Removes the first element from an array and returns it.

    Returns ManagedInstance | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ManagedInstance[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ManagedInstance[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ManagedInstance, index: number, array: ManagedInstance[]): boolean
        • Parameters

          • value: ManagedInstance
          • index: number
          • array: ManagedInstance[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ManagedInstance[]
  • splice(start: number, deleteCount: number, ...items: ManagedInstance[]): ManagedInstance[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ManagedInstance[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ManagedInstance[]

      Elements to insert into the array in place of the deleted elements.

    Returns ManagedInstance[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ManagedInstance[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ManagedInstance[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ManagedInstance>
  • Returns an iterable of values in the array

    Returns IterableIterator<ManagedInstance>

type

type: object

className

className: string = "ManagedInstanceListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedInstance"

name

name: "Composite" = "Composite"

Const ManagedInstancePairInfo

ManagedInstancePairInfo: object

Pairs of Managed Instances in the failover group.

Optional partnerManagedInstanceId

partnerManagedInstanceId: undefined | string

Id of Partner Managed Instance in pair.

Optional primaryManagedInstanceId

primaryManagedInstanceId: undefined | string

Id of Primary Managed Instance in pair.

serializedName

serializedName: string = "ManagedInstancePairInfo"

type

type: object

className

className: string = "ManagedInstancePairInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

partnerManagedInstanceId

partnerManagedInstanceId: object

serializedName

serializedName: string = "partnerManagedInstanceId"

type

type: object

name

name: "String" = "String"

primaryManagedInstanceId

primaryManagedInstanceId: object

serializedName

serializedName: string = "primaryManagedInstanceId"

type

type: object

name

name: "String" = "String"

Const ManagedInstanceUpdate

ManagedInstanceUpdate: object

An update request for an Azure SQL Database managed instance.

Optional administratorLogin

administratorLogin: undefined | string

Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).

Optional administratorLoginPassword

administratorLoginPassword: undefined | string

The administrator login password (required for managed instance creation).

Optional collation

collation: undefined | string

Collation of the managed instance.

Optional dnsZone

dnsZone: undefined | string

The Dns Zone that the managed instance is in. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dnsZonePartner

dnsZonePartner: undefined | string

The resource id of another managed instance whose DNS zone this managed instance will share after creation.

Optional fullyQualifiedDomainName

fullyQualifiedDomainName: undefined | string

The fully qualified domain name of the managed instance. NOTE: This property will not be serialized. It can only be populated by the server.

Optional licenseType

licenseType: undefined | string

The license type. Possible values are 'LicenseIncluded' and 'BasePrice'.

Optional proxyOverride

Connection type used for connecting to the instance. Possible values include: 'Proxy', 'Redirect', 'Default'

Optional publicDataEndpointEnabled

publicDataEndpointEnabled: undefined | false | true

Whether or not the public data endpoint is enabled.

serializedName

serializedName: string = "ManagedInstanceUpdate"

Optional sku

sku: Sku

Managed instance sku

Optional state

state: undefined | string

The state of the managed instance. NOTE: This property will not be serialized. It can only be populated by the server.

Optional storageSizeInGB

storageSizeInGB: undefined | number

The maximum storage size in GB.

Optional subnetId

subnetId: undefined | string

Subnet resource ID for the managed instance.

Optional tags

tags: undefined | object

Resource tags.

Optional timezoneId

timezoneId: undefined | string

Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time".

Optional vCores

vCores: undefined | number

The number of VCores.

type

type: object

className

className: string = "ManagedInstanceUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

administratorLogin

administratorLogin: object

serializedName

serializedName: string = "properties.administratorLogin"

type

type: object

name

name: "String" = "String"

administratorLoginPassword

administratorLoginPassword: object

serializedName

serializedName: string = "properties.administratorLoginPassword"

type

type: object

name

name: "String" = "String"

collation

collation: object

serializedName

serializedName: string = "properties.collation"

type

type: object

name

name: "String" = "String"

dnsZone

dnsZone: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.dnsZone"

type

type: object

name

name: "String" = "String"

dnsZonePartner

dnsZonePartner: object

serializedName

serializedName: string = "properties.dnsZonePartner"

type

type: object

name

name: "String" = "String"

fullyQualifiedDomainName

fullyQualifiedDomainName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.fullyQualifiedDomainName"

type

type: object

name

name: "String" = "String"

licenseType

licenseType: object

serializedName

serializedName: string = "properties.licenseType"

type

type: object

name

name: "String" = "String"

proxyOverride

proxyOverride: object

serializedName

serializedName: string = "properties.proxyOverride"

type

type: object

name

name: "String" = "String"

publicDataEndpointEnabled

publicDataEndpointEnabled: object

serializedName

serializedName: string = "properties.publicDataEndpointEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

storageSizeInGB

storageSizeInGB: object

serializedName

serializedName: string = "properties.storageSizeInGB"

type

type: object

name

name: "Number" = "Number"

subnetId

subnetId: object

serializedName

serializedName: string = "properties.subnetId"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

timezoneId

timezoneId: object

serializedName

serializedName: string = "properties.timezoneId"

type

type: object

name

name: "String" = "String"

vCores

vCores: object

serializedName

serializedName: string = "properties.vCores"

type

type: object

name

name: "Number" = "Number"

Const ManagedInstanceVcoresCapability

ManagedInstanceVcoresCapability: object

The managed instance virtual cores capability.

Optional name

name: undefined | string

The virtual cores identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "ManagedInstanceVcoresCapability"

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional value

value: undefined | number

The virtual cores value. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ManagedInstanceVcoresCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "Number" = "Number"

Const ManagedInstanceVersionCapability

ManagedInstanceVersionCapability: object

The managed instance capability

Optional name

name: undefined | string

The server version name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "ManagedInstanceVersionCapability"

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedEditions

supportedEditions: ManagedInstanceEditionCapability[]

The list of supported managed instance editions. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ManagedInstanceVersionCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

supportedEditions

supportedEditions: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedEditions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedInstanceEditionCapability"

name

name: "Composite" = "Composite"

Const ManagedInstanceVulnerabilityAssessment

ManagedInstanceVulnerabilityAssessment: object

A managed instance vulnerability assessment.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional recurringScans

The recurring scans settings

serializedName

serializedName: string = "ManagedInstanceVulnerabilityAssessment"

Optional storageAccountAccessKey

storageAccountAccessKey: undefined | string

Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.

storageContainerPath

storageContainerPath: string

A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).

Optional storageContainerSasKey

storageContainerSasKey: undefined | string

A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.

type

type: object

className

className: string = "ManagedInstanceVulnerabilityAssessment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

recurringScans

recurringScans: object

serializedName

serializedName: string = "properties.recurringScans"

type

type: object

className

className: string = "VulnerabilityAssessmentRecurringScansProperties"

name

name: "Composite" = "Composite"

storageAccountAccessKey

storageAccountAccessKey: object

serializedName

serializedName: string = "properties.storageAccountAccessKey"

type

type: object

name

name: "String" = "String"

storageContainerPath

storageContainerPath: object

required

required: true = true

serializedName

serializedName: string = "properties.storageContainerPath"

type

type: object

name

name: "String" = "String"

storageContainerSasKey

storageContainerSasKey: object

serializedName

serializedName: string = "properties.storageContainerSasKey"

type

type: object

name

name: "String" = "String"

Const ManagedInstanceVulnerabilityAssessmentListResult

ManagedInstanceVulnerabilityAssessmentListResult: object
interface

A list of the ManagedInstance's vulnerability assessments.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedInstanceVulnerabilityAssessmentListResult"

__@iterator

  • __@iterator(): IterableIterator<ManagedInstanceVulnerabilityAssessment>
  • Iterator

    Returns IterableIterator<ManagedInstanceVulnerabilityAssessment>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ManagedInstanceVulnerabilityAssessment>[]): ManagedInstanceVulnerabilityAssessment[]
  • concat(...items: (T | ConcatArray<T>)[]): ManagedInstanceVulnerabilityAssessment[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ManagedInstanceVulnerabilityAssessment>[]

      Additional items to add to the end of array1.

    Returns ManagedInstanceVulnerabilityAssessment[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ManagedInstanceVulnerabilityAssessment[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ManagedInstanceVulnerabilityAssessment]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ManagedInstanceVulnerabilityAssessment]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ManagedInstanceVulnerabilityAssessment, index: number, array: ManagedInstanceVulnerabilityAssessment[]): boolean
        • Parameters

          • value: ManagedInstanceVulnerabilityAssessment
          • index: number
          • array: ManagedInstanceVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ManagedInstanceVulnerabilityAssessment, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ManagedInstanceVulnerabilityAssessment

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ManagedInstanceVulnerabilityAssessment[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ManagedInstanceVulnerabilityAssessment

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstanceVulnerabilityAssessment, index: number, array: ManagedInstanceVulnerabilityAssessment[]): boolean
        • Parameters

          • value: ManagedInstanceVulnerabilityAssessment
          • index: number
          • array: ManagedInstanceVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstanceVulnerabilityAssessment, index: number, array: ManagedInstanceVulnerabilityAssessment[]): any
        • Parameters

          • value: ManagedInstanceVulnerabilityAssessment
          • index: number
          • array: ManagedInstanceVulnerabilityAssessment[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ManagedInstanceVulnerabilityAssessment[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ManagedInstanceVulnerabilityAssessment | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ManagedInstanceVulnerabilityAssessment

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ManagedInstanceVulnerabilityAssessment, index: number, obj: ManagedInstanceVulnerabilityAssessment[]): boolean
        • Parameters

          • this: void
          • value: ManagedInstanceVulnerabilityAssessment
          • index: number
          • obj: ManagedInstanceVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ManagedInstanceVulnerabilityAssessment, index: number, obj: ManagedInstanceVulnerabilityAssessment[]): boolean
        • Parameters

          • value: ManagedInstanceVulnerabilityAssessment
          • index: number
          • obj: ManagedInstanceVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

    Returns ManagedInstanceVulnerabilityAssessment | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ManagedInstanceVulnerabilityAssessment, index: number, obj: ManagedInstanceVulnerabilityAssessment[]): boolean
        • Parameters

          • value: ManagedInstanceVulnerabilityAssessment
          • index: number
          • obj: ManagedInstanceVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstanceVulnerabilityAssessment, index: number, array: ManagedInstanceVulnerabilityAssessment[]): void
        • Parameters

          • value: ManagedInstanceVulnerabilityAssessment
          • index: number
          • array: ManagedInstanceVulnerabilityAssessment[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ManagedInstanceVulnerabilityAssessment, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ManagedInstanceVulnerabilityAssessment

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ManagedInstanceVulnerabilityAssessment, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ManagedInstanceVulnerabilityAssessment

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ManagedInstanceVulnerabilityAssessment, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ManagedInstanceVulnerabilityAssessment

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ManagedInstanceVulnerabilityAssessment, index: number, array: ManagedInstanceVulnerabilityAssessment[]): U
        • Parameters

          • value: ManagedInstanceVulnerabilityAssessment
          • index: number
          • array: ManagedInstanceVulnerabilityAssessment[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ManagedInstanceVulnerabilityAssessment | undefined
  • Removes the last element from an array and returns it.

    Returns ManagedInstanceVulnerabilityAssessment | undefined

push

  • push(...items: ManagedInstanceVulnerabilityAssessment[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ManagedInstanceVulnerabilityAssessment[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ManagedInstanceVulnerabilityAssessment
  • reduce(callbackfn: function, initialValue: ManagedInstanceVulnerabilityAssessment): ManagedInstanceVulnerabilityAssessment
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedInstanceVulnerabilityAssessment, currentValue: ManagedInstanceVulnerabilityAssessment, currentIndex: number, array: ManagedInstanceVulnerabilityAssessment[]): ManagedInstanceVulnerabilityAssessment
        • Parameters

          • previousValue: ManagedInstanceVulnerabilityAssessment
          • currentValue: ManagedInstanceVulnerabilityAssessment
          • currentIndex: number
          • array: ManagedInstanceVulnerabilityAssessment[]

          Returns ManagedInstanceVulnerabilityAssessment

    Returns ManagedInstanceVulnerabilityAssessment

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedInstanceVulnerabilityAssessment, currentValue: ManagedInstanceVulnerabilityAssessment, currentIndex: number, array: ManagedInstanceVulnerabilityAssessment[]): ManagedInstanceVulnerabilityAssessment
        • Parameters

          • previousValue: ManagedInstanceVulnerabilityAssessment
          • currentValue: ManagedInstanceVulnerabilityAssessment
          • currentIndex: number
          • array: ManagedInstanceVulnerabilityAssessment[]

          Returns ManagedInstanceVulnerabilityAssessment

    • initialValue: ManagedInstanceVulnerabilityAssessment

    Returns ManagedInstanceVulnerabilityAssessment

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedInstanceVulnerabilityAssessment, currentIndex: number, array: ManagedInstanceVulnerabilityAssessment[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedInstanceVulnerabilityAssessment
          • currentIndex: number
          • array: ManagedInstanceVulnerabilityAssessment[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ManagedInstanceVulnerabilityAssessment
  • reduceRight(callbackfn: function, initialValue: ManagedInstanceVulnerabilityAssessment): ManagedInstanceVulnerabilityAssessment
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedInstanceVulnerabilityAssessment, currentValue: ManagedInstanceVulnerabilityAssessment, currentIndex: number, array: ManagedInstanceVulnerabilityAssessment[]): ManagedInstanceVulnerabilityAssessment
        • Parameters

          • previousValue: ManagedInstanceVulnerabilityAssessment
          • currentValue: ManagedInstanceVulnerabilityAssessment
          • currentIndex: number
          • array: ManagedInstanceVulnerabilityAssessment[]

          Returns ManagedInstanceVulnerabilityAssessment

    Returns ManagedInstanceVulnerabilityAssessment

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedInstanceVulnerabilityAssessment, currentValue: ManagedInstanceVulnerabilityAssessment, currentIndex: number, array: ManagedInstanceVulnerabilityAssessment[]): ManagedInstanceVulnerabilityAssessment
        • Parameters

          • previousValue: ManagedInstanceVulnerabilityAssessment
          • currentValue: ManagedInstanceVulnerabilityAssessment
          • currentIndex: number
          • array: ManagedInstanceVulnerabilityAssessment[]

          Returns ManagedInstanceVulnerabilityAssessment

    • initialValue: ManagedInstanceVulnerabilityAssessment

    Returns ManagedInstanceVulnerabilityAssessment

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedInstanceVulnerabilityAssessment, currentIndex: number, array: ManagedInstanceVulnerabilityAssessment[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedInstanceVulnerabilityAssessment
          • currentIndex: number
          • array: ManagedInstanceVulnerabilityAssessment[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ManagedInstanceVulnerabilityAssessment[]
  • Reverses the elements in an Array.

    Returns ManagedInstanceVulnerabilityAssessment[]

shift

  • shift(): ManagedInstanceVulnerabilityAssessment | undefined
  • Removes the first element from an array and returns it.

    Returns ManagedInstanceVulnerabilityAssessment | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ManagedInstanceVulnerabilityAssessment[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ManagedInstanceVulnerabilityAssessment[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ManagedInstanceVulnerabilityAssessment, index: number, array: ManagedInstanceVulnerabilityAssessment[]): boolean
        • Parameters

          • value: ManagedInstanceVulnerabilityAssessment
          • index: number
          • array: ManagedInstanceVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ManagedInstanceVulnerabilityAssessment[]
  • splice(start: number, deleteCount: number, ...items: ManagedInstanceVulnerabilityAssessment[]): ManagedInstanceVulnerabilityAssessment[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ManagedInstanceVulnerabilityAssessment[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ManagedInstanceVulnerabilityAssessment[]

      Elements to insert into the array in place of the deleted elements.

    Returns ManagedInstanceVulnerabilityAssessment[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ManagedInstanceVulnerabilityAssessment[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ManagedInstanceVulnerabilityAssessment[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ManagedInstanceVulnerabilityAssessment>
  • Returns an iterable of values in the array

    Returns IterableIterator<ManagedInstanceVulnerabilityAssessment>

type

type: object

className

className: string = "ManagedInstanceVulnerabilityAssessmentListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedInstanceVulnerabilityAssessment"

name

name: "Composite" = "Composite"

Const ManagedServerSecurityAlertPolicy

ManagedServerSecurityAlertPolicy: object

A managed server security alert policy.

Optional creationTime

creationTime: Date

Specifies the UTC creation time of the policy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional disabledAlerts

disabledAlerts: string[]

Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action

Optional emailAccountAdmins

emailAccountAdmins: undefined | false | true

Specifies that the alert is sent to the account administrators.

Optional emailAddresses

emailAddresses: string[]

Specifies an array of e-mail addresses to which the alert is sent.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional retentionDays

retentionDays: undefined | number

Specifies the number of days to keep in the Threat Detection audit logs.

serializedName

serializedName: string = "ManagedServerSecurityAlertPolicy"

state

Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. Possible values include: 'New', 'Enabled', 'Disabled'

Optional storageAccountAccessKey

storageAccountAccessKey: undefined | string

Specifies the identifier key of the Threat Detection audit storage account.

Optional storageEndpoint

storageEndpoint: undefined | string

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

type

type: object

className

className: string = "ManagedServerSecurityAlertPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

disabledAlerts

disabledAlerts: object

serializedName

serializedName: string = "properties.disabledAlerts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

emailAccountAdmins

emailAccountAdmins: object

serializedName

serializedName: string = "properties.emailAccountAdmins"

type

type: object

name

name: "Boolean" = "Boolean"

emailAddresses

emailAddresses: object

serializedName

serializedName: string = "properties.emailAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

retentionDays

retentionDays: object

serializedName

serializedName: string = "properties.retentionDays"

type

type: object

name

name: "Number" = "Number"

state

state: object

required

required: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["New","Enabled","Disabled"]

name

name: "Enum" = "Enum"

storageAccountAccessKey

storageAccountAccessKey: object

serializedName

serializedName: string = "properties.storageAccountAccessKey"

type

type: object

name

name: "String" = "String"

storageEndpoint

storageEndpoint: object

serializedName

serializedName: string = "properties.storageEndpoint"

type

type: object

name

name: "String" = "String"

Const ManagedServerSecurityAlertPolicyListResult

ManagedServerSecurityAlertPolicyListResult: object
interface

A list of the managed Server's security alert policies.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedServerSecurityAlertPolicyListResult"

__@iterator

  • __@iterator(): IterableIterator<ManagedServerSecurityAlertPolicy>
  • Iterator

    Returns IterableIterator<ManagedServerSecurityAlertPolicy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ManagedServerSecurityAlertPolicy>[]): ManagedServerSecurityAlertPolicy[]
  • concat(...items: (T | ConcatArray<T>)[]): ManagedServerSecurityAlertPolicy[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ManagedServerSecurityAlertPolicy>[]

      Additional items to add to the end of array1.

    Returns ManagedServerSecurityAlertPolicy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ManagedServerSecurityAlertPolicy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ManagedServerSecurityAlertPolicy]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ManagedServerSecurityAlertPolicy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ManagedServerSecurityAlertPolicy, index: number, array: ManagedServerSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ManagedServerSecurityAlertPolicy
          • index: number
          • array: ManagedServerSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ManagedServerSecurityAlertPolicy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ManagedServerSecurityAlertPolicy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ManagedServerSecurityAlertPolicy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ManagedServerSecurityAlertPolicy

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedServerSecurityAlertPolicy, index: number, array: ManagedServerSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ManagedServerSecurityAlertPolicy
          • index: number
          • array: ManagedServerSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ManagedServerSecurityAlertPolicy, index: number, array: ManagedServerSecurityAlertPolicy[]): any
        • Parameters

          • value: ManagedServerSecurityAlertPolicy
          • index: number
          • array: ManagedServerSecurityAlertPolicy[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ManagedServerSecurityAlertPolicy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ManagedServerSecurityAlertPolicy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ManagedServerSecurityAlertPolicy

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ManagedServerSecurityAlertPolicy, index: number, obj: ManagedServerSecurityAlertPolicy[]): boolean
        • Parameters

          • this: void
          • value: ManagedServerSecurityAlertPolicy
          • index: number
          • obj: ManagedServerSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ManagedServerSecurityAlertPolicy, index: number, obj: ManagedServerSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ManagedServerSecurityAlertPolicy
          • index: number
          • obj: ManagedServerSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

    Returns ManagedServerSecurityAlertPolicy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ManagedServerSecurityAlertPolicy, index: number, obj: ManagedServerSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ManagedServerSecurityAlertPolicy
          • index: number
          • obj: ManagedServerSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ManagedServerSecurityAlertPolicy, index: number, array: ManagedServerSecurityAlertPolicy[]): void
        • Parameters

          • value: ManagedServerSecurityAlertPolicy
          • index: number
          • array: ManagedServerSecurityAlertPolicy[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ManagedServerSecurityAlertPolicy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ManagedServerSecurityAlertPolicy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ManagedServerSecurityAlertPolicy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ManagedServerSecurityAlertPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ManagedServerSecurityAlertPolicy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ManagedServerSecurityAlertPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ManagedServerSecurityAlertPolicy, index: number, array: ManagedServerSecurityAlertPolicy[]): U
        • Parameters

          • value: ManagedServerSecurityAlertPolicy
          • index: number
          • array: ManagedServerSecurityAlertPolicy[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ManagedServerSecurityAlertPolicy | undefined
  • Removes the last element from an array and returns it.

    Returns ManagedServerSecurityAlertPolicy | undefined

push

  • push(...items: ManagedServerSecurityAlertPolicy[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ManagedServerSecurityAlertPolicy[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ManagedServerSecurityAlertPolicy
  • reduce(callbackfn: function, initialValue: ManagedServerSecurityAlertPolicy): ManagedServerSecurityAlertPolicy
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedServerSecurityAlertPolicy, currentValue: ManagedServerSecurityAlertPolicy, currentIndex: number, array: ManagedServerSecurityAlertPolicy[]): ManagedServerSecurityAlertPolicy
        • Parameters

          • previousValue: ManagedServerSecurityAlertPolicy
          • currentValue: ManagedServerSecurityAlertPolicy
          • currentIndex: number
          • array: ManagedServerSecurityAlertPolicy[]

          Returns ManagedServerSecurityAlertPolicy

    Returns ManagedServerSecurityAlertPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedServerSecurityAlertPolicy, currentValue: ManagedServerSecurityAlertPolicy, currentIndex: number, array: ManagedServerSecurityAlertPolicy[]): ManagedServerSecurityAlertPolicy
        • Parameters

          • previousValue: ManagedServerSecurityAlertPolicy
          • currentValue: ManagedServerSecurityAlertPolicy
          • currentIndex: number
          • array: ManagedServerSecurityAlertPolicy[]

          Returns ManagedServerSecurityAlertPolicy

    • initialValue: ManagedServerSecurityAlertPolicy

    Returns ManagedServerSecurityAlertPolicy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedServerSecurityAlertPolicy, currentIndex: number, array: ManagedServerSecurityAlertPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedServerSecurityAlertPolicy
          • currentIndex: number
          • array: ManagedServerSecurityAlertPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ManagedServerSecurityAlertPolicy
  • reduceRight(callbackfn: function, initialValue: ManagedServerSecurityAlertPolicy): ManagedServerSecurityAlertPolicy
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ManagedServerSecurityAlertPolicy, currentValue: ManagedServerSecurityAlertPolicy, currentIndex: number, array: ManagedServerSecurityAlertPolicy[]): ManagedServerSecurityAlertPolicy
        • Parameters

          • previousValue: ManagedServerSecurityAlertPolicy
          • currentValue: ManagedServerSecurityAlertPolicy
          • currentIndex: number
          • array: ManagedServerSecurityAlertPolicy[]

          Returns ManagedServerSecurityAlertPolicy

    Returns ManagedServerSecurityAlertPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: ManagedServerSecurityAlertPolicy, currentValue: ManagedServerSecurityAlertPolicy, currentIndex: number, array: ManagedServerSecurityAlertPolicy[]): ManagedServerSecurityAlertPolicy
        • Parameters

          • previousValue: ManagedServerSecurityAlertPolicy
          • currentValue: ManagedServerSecurityAlertPolicy
          • currentIndex: number
          • array: ManagedServerSecurityAlertPolicy[]

          Returns ManagedServerSecurityAlertPolicy

    • initialValue: ManagedServerSecurityAlertPolicy

    Returns ManagedServerSecurityAlertPolicy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ManagedServerSecurityAlertPolicy, currentIndex: number, array: ManagedServerSecurityAlertPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: ManagedServerSecurityAlertPolicy
          • currentIndex: number
          • array: ManagedServerSecurityAlertPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ManagedServerSecurityAlertPolicy[]
  • Reverses the elements in an Array.

    Returns ManagedServerSecurityAlertPolicy[]

shift

  • shift(): ManagedServerSecurityAlertPolicy | undefined
  • Removes the first element from an array and returns it.

    Returns ManagedServerSecurityAlertPolicy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ManagedServerSecurityAlertPolicy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ManagedServerSecurityAlertPolicy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ManagedServerSecurityAlertPolicy, index: number, array: ManagedServerSecurityAlertPolicy[]): boolean
        • Parameters

          • value: ManagedServerSecurityAlertPolicy
          • index: number
          • array: ManagedServerSecurityAlertPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ManagedServerSecurityAlertPolicy[]
  • splice(start: number, deleteCount: number, ...items: ManagedServerSecurityAlertPolicy[]): ManagedServerSecurityAlertPolicy[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ManagedServerSecurityAlertPolicy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ManagedServerSecurityAlertPolicy[]

      Elements to insert into the array in place of the deleted elements.

    Returns ManagedServerSecurityAlertPolicy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ManagedServerSecurityAlertPolicy[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ManagedServerSecurityAlertPolicy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ManagedServerSecurityAlertPolicy>
  • Returns an iterable of values in the array

    Returns IterableIterator<ManagedServerSecurityAlertPolicy>

type

type: object

className

className: string = "ManagedServerSecurityAlertPolicyListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedServerSecurityAlertPolicy"

name

name: "Composite" = "Composite"

Const MaxSizeCapability

MaxSizeCapability: object

The maximum size capability.

Optional limit

limit: undefined | number

The maximum size limit (see 'unit' for the units). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MaxSizeCapability"

Optional unit

The units that the limit is expressed in. Possible values include: 'Megabytes', 'Gigabytes', 'Terabytes', 'Petabytes' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "MaxSizeCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

limit

limit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "limit"

type

type: object

name

name: "Number" = "Number"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const MaxSizeRangeCapability

MaxSizeRangeCapability: object

The maximum size range capability.

Optional logSize

Size of transaction log. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxValue

Maximum value. NOTE: This property will not be serialized. It can only be populated by the server.

Optional minValue

Minimum value. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

Optional scaleSize

Scale/step size for discrete values between the minimum value and the maximum value. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MaxSizeRangeCapability"

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "MaxSizeRangeCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

logSize

logSize: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "logSize"

type

type: object

className

className: string = "LogSizeCapability"

name

name: "Composite" = "Composite"

maxValue

maxValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "maxValue"

type

type: object

className

className: string = "MaxSizeCapability"

name

name: "Composite" = "Composite"

minValue

minValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "minValue"

type

type: object

className

className: string = "MaxSizeCapability"

name

name: "Composite" = "Composite"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

scaleSize

scaleSize: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "scaleSize"

type

type: object

className

className: string = "MaxSizeCapability"

name

name: "Composite" = "Composite"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

Const Metric

Metric: object

Database metrics.

Optional endTime

endTime: Date

The end time for the metric (ISO-8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional metricValues

metricValues: MetricValue[]

The metric values for the specified time window and timestep. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

The name information for the metric. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Metric"

Optional startTime

startTime: Date

The start time for the metric (ISO-8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional timeGrain

timeGrain: undefined | string

The time step to be used to summarize the metric values. NOTE: This property will not be serialized. It can only be populated by the server.

Optional unit

unit: UnitType

The unit of the metric. Possible values include: 'count', 'bytes', 'seconds', 'percent', 'countPerSecond', 'bytesPerSecond' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "Metric"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

metricValues

metricValues: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "metricValues"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricValue"

name

name: "Composite" = "Composite"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "MetricName"

name

name: "Composite" = "Composite"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

timeGrain

timeGrain: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "String" = "String"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const MetricAvailability

MetricAvailability: object

A metric availability value.

Optional retention

retention: undefined | string

The length of retention for the database metric. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MetricAvailability"

Optional timeGrain

timeGrain: undefined | string

The granularity of the database metric. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "MetricAvailability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

retention

retention: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "retention"

type

type: object

name

name: "String" = "String"

timeGrain

timeGrain: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "String" = "String"

Const MetricDefinition

MetricDefinition: object

A database metric definition.

Optional metricAvailabilities

metricAvailabilities: MetricAvailability[]

The list of database metric availabilities for the metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

The name information for the metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional primaryAggregationType

primaryAggregationType: PrimaryAggregationType

The primary aggregation type defining how metric values are displayed. Possible values include: 'None', 'Average', 'Count', 'Minimum', 'Maximum', 'Total' NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceUri

resourceUri: undefined | string

The resource uri of the database. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MetricDefinition"

Optional unit

The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "MetricDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

metricAvailabilities

metricAvailabilities: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "metricAvailabilities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricAvailability"

name

name: "Composite" = "Composite"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "MetricName"

name

name: "Composite" = "Composite"

primaryAggregationType

primaryAggregationType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "primaryAggregationType"

type

type: object

name

name: "String" = "String"

resourceUri

resourceUri: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resourceUri"

type

type: object

name

name: "String" = "String"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const MetricDefinitionListResult

MetricDefinitionListResult: object
interface

The response to a list database metric definitions request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "MetricDefinitionListResult"

__@iterator

  • __@iterator(): IterableIterator<MetricDefinition>
  • Iterator

    Returns IterableIterator<MetricDefinition>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<MetricDefinition>[]): MetricDefinition[]
  • concat(...items: (T | ConcatArray<T>)[]): MetricDefinition[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<MetricDefinition>[]

      Additional items to add to the end of array1.

    Returns MetricDefinition[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns MetricDefinition[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, MetricDefinition]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, MetricDefinition]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: MetricDefinition, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: MetricDefinition

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): MetricDefinition[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: MetricDefinition

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): any
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns MetricDefinition[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): MetricDefinition | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: MetricDefinition

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: MetricDefinition, index: number, obj: MetricDefinition[]): boolean
        • Parameters

          • this: void
          • value: MetricDefinition
          • index: number
          • obj: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: MetricDefinition, index: number, obj: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • obj: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

    Returns MetricDefinition | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: MetricDefinition, index: number, obj: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • obj: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): void
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: MetricDefinition, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: MetricDefinition

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: MetricDefinition, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: MetricDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: MetricDefinition, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: MetricDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): U
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): MetricDefinition | undefined
  • Removes the last element from an array and returns it.

    Returns MetricDefinition | undefined

push

  • push(...items: MetricDefinition[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: MetricDefinition[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): MetricDefinition
  • reduce(callbackfn: function, initialValue: MetricDefinition): MetricDefinition
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: MetricDefinition, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): MetricDefinition
        • Parameters

          • previousValue: MetricDefinition
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns MetricDefinition

    Returns MetricDefinition

  • Parameters

    • callbackfn: function
        • (previousValue: MetricDefinition, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): MetricDefinition
        • Parameters

          • previousValue: MetricDefinition
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns MetricDefinition

    • initialValue: MetricDefinition

    Returns MetricDefinition

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): U
        • Parameters

          • previousValue: U
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): MetricDefinition
  • reduceRight(callbackfn: function, initialValue: MetricDefinition): MetricDefinition
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: MetricDefinition, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): MetricDefinition
        • Parameters

          • previousValue: MetricDefinition
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns MetricDefinition

    Returns MetricDefinition

  • Parameters

    • callbackfn: function
        • (previousValue: MetricDefinition, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): MetricDefinition
        • Parameters

          • previousValue: MetricDefinition
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns MetricDefinition

    • initialValue: MetricDefinition

    Returns MetricDefinition

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): U
        • Parameters

          • previousValue: U
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): MetricDefinition[]
  • Reverses the elements in an Array.

    Returns MetricDefinition[]

shift

  • shift(): MetricDefinition | undefined
  • Removes the first element from an array and returns it.

    Returns MetricDefinition | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): MetricDefinition[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns MetricDefinition[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): MetricDefinition[]
  • splice(start: number, deleteCount: number, ...items: MetricDefinition[]): MetricDefinition[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns MetricDefinition[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: MetricDefinition[]

      Elements to insert into the array in place of the deleted elements.

    Returns MetricDefinition[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: MetricDefinition[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: MetricDefinition[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<MetricDefinition>
  • Returns an iterable of values in the array

    Returns IterableIterator<MetricDefinition>

type

type: object

className

className: string = "MetricDefinitionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricDefinition"

name

name: "Composite" = "Composite"

Const MetricListResult

MetricListResult: object
interface

The response to a list database metrics request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "MetricListResult"

__@iterator

  • __@iterator(): IterableIterator<Metric>
  • Iterator

    Returns IterableIterator<Metric>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Metric>[]): Metric[]
  • concat(...items: (T | ConcatArray<T>)[]): Metric[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Metric>[]

      Additional items to add to the end of array1.

    Returns Metric[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Metric[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Metric]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Metric]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Metric, index: number, array: Metric[]): boolean
        • Parameters

          • value: Metric
          • index: number
          • array: Metric[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Metric, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Metric

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Metric[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Metric

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Metric, index: number, array: Metric[]): boolean
        • Parameters

          • value: Metric
          • index: number
          • array: Metric[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Metric, index: number, array: Metric[]): any
        • Parameters

          • value: Metric
          • index: number
          • array: Metric[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Metric[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Metric | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Metric

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Metric, index: number, obj: Metric[]): boolean
        • Parameters

          • this: void
          • value: Metric
          • index: number
          • obj: Metric[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Metric, index: number, obj: Metric[]): boolean
        • Parameters

          • value: Metric
          • index: number
          • obj: Metric[]

          Returns boolean

    • Optional thisArg: any

    Returns Metric | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Metric, index: number, obj: Metric[]): boolean
        • Parameters

          • value: Metric
          • index: number
          • obj: Metric[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Metric, index: number, array: Metric[]): void
        • Parameters

          • value: Metric
          • index: number
          • array: Metric[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Metric, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Metric

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Metric, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Metric

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Metric, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Metric

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Metric, index: number, array: Metric[]): U
        • Parameters

          • value: Metric
          • index: number
          • array: Metric[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Metric | undefined
  • Removes the last element from an array and returns it.

    Returns Metric | undefined

push

  • push(...items: Metric[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Metric[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Metric
  • reduce(callbackfn: function, initialValue: Metric): Metric
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Metric, currentValue: Metric, currentIndex: number, array: Metric[]): Metric
        • Parameters

          • previousValue: Metric
          • currentValue: Metric
          • currentIndex: number
          • array: Metric[]

          Returns Metric

    Returns Metric

  • Parameters

    • callbackfn: function
        • (previousValue: Metric, currentValue: Metric, currentIndex: number, array: Metric[]): Metric
        • Parameters

          • previousValue: Metric
          • currentValue: Metric
          • currentIndex: number
          • array: Metric[]

          Returns Metric

    • initialValue: Metric

    Returns Metric

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Metric, currentIndex: number, array: Metric[]): U
        • Parameters

          • previousValue: U
          • currentValue: Metric
          • currentIndex: number
          • array: Metric[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Metric
  • reduceRight(callbackfn: function, initialValue: Metric): Metric
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Metric, currentValue: Metric, currentIndex: number, array: Metric[]): Metric
        • Parameters

          • previousValue: Metric
          • currentValue: Metric
          • currentIndex: number
          • array: Metric[]

          Returns Metric

    Returns Metric

  • Parameters

    • callbackfn: function
        • (previousValue: Metric, currentValue: Metric, currentIndex: number, array: Metric[]): Metric
        • Parameters

          • previousValue: Metric
          • currentValue: Metric
          • currentIndex: number
          • array: Metric[]

          Returns Metric

    • initialValue: Metric

    Returns Metric

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Metric, currentIndex: number, array: Metric[]): U
        • Parameters

          • previousValue: U
          • currentValue: Metric
          • currentIndex: number
          • array: Metric[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Metric[]
  • Reverses the elements in an Array.

    Returns Metric[]

shift

  • shift(): Metric | undefined
  • Removes the first element from an array and returns it.

    Returns Metric | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Metric[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Metric[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Metric, index: number, array: Metric[]): boolean
        • Parameters

          • value: Metric
          • index: number
          • array: Metric[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Metric[]
  • splice(start: number, deleteCount: number, ...items: Metric[]): Metric[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Metric[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Metric[]

      Elements to insert into the array in place of the deleted elements.

    Returns Metric[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Metric[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Metric[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Metric>
  • Returns an iterable of values in the array

    Returns IterableIterator<Metric>

type

type: object

className

className: string = "MetricListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Metric"

name

name: "Composite" = "Composite"

Const MetricName

MetricName: object

A database metric name.

Optional localizedValue

localizedValue: undefined | string

The friendly name of the database metric. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MetricName"

Optional value

value: undefined | string

The name of the database metric. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "MetricName"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localizedValue

localizedValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "localizedValue"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const MetricValue

MetricValue: object

Represents database metrics.

Optional average

average: undefined | number

The average value of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional count

count: undefined | number

The number of values for the metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maximum

maximum: undefined | number

The max value of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional minimum

minimum: undefined | number

The min value of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MetricValue"

Optional timestamp

timestamp: Date

The metric timestamp (ISO-8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional total

total: undefined | number

The total value of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "MetricValue"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

average

average: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "average"

type

type: object

name

name: "Number" = "Number"

count

count: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

maximum

maximum: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "maximum"

type

type: object

name

name: "Number" = "Number"

minimum

minimum: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "minimum"

type

type: object

name

name: "Number" = "Number"

timestamp

timestamp: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "timestamp"

type

type: object

name

name: "DateTime" = "DateTime"

total

total: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "total"

type

type: object

name

name: "Number" = "Number"

Const Operation

Operation: object

SQL REST API operation definition.

Optional display

The localized display information for this particular operation / action. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the operation being performed on this particular object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional origin

The intended executor of the operation. Possible values include: 'user', 'system' NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: undefined | object

Additional descriptions for the operation. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Operation"

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

origin

origin: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

properties

properties: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

Const OperationDisplay

OperationDisplay: object

Display metadata associated with the operation.

Optional description

description: undefined | string

The localized friendly description for the operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operation

operation: undefined | string

The localized friendly name for the operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provider

provider: undefined | string

The localized friendly form of the resource provider name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resource

resource: undefined | string

The localized friendly form of the resource type related to this action/operation. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "OperationDisplay"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

operation

operation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const OperationImpact

OperationImpact: object

The impact of an operation, both in absolute and relative terms.

Optional changeValueAbsolute

changeValueAbsolute: undefined | number

The absolute impact to dimension. NOTE: This property will not be serialized. It can only be populated by the server.

Optional changeValueRelative

changeValueRelative: undefined | number

The relative impact to dimension (null if not applicable) NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the impact dimension. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "OperationImpact"

Optional unit

unit: undefined | string

The unit in which estimated impact to dimension is measured. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "OperationImpact"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

changeValueAbsolute

changeValueAbsolute: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "changeValueAbsolute"

type

type: object

name

name: "Number" = "Number"

changeValueRelative

changeValueRelative: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "changeValueRelative"

type

type: object

name

name: "Number" = "Number"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const OperationListResult

OperationListResult: object
interface

Result of the request to list SQL operations.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "OperationListResult"

__@iterator

  • __@iterator(): IterableIterator<Operation>
  • Iterator

    Returns IterableIterator<Operation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Operation>[]): Operation[]
  • concat(...items: (T | ConcatArray<T>)[]): Operation[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Operation>[]

      Additional items to add to the end of array1.

    Returns Operation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Operation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Operation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Operation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Operation, index: number, array: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Operation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Operation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Operation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Operation

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Operation, index: number, array: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Operation, index: number, array: Operation[]): any
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Operation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Operation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Operation

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Operation, index: number, obj: Operation[]): boolean
        • Parameters

          • this: void
          • value: Operation
          • index: number
          • obj: Operation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Operation, index: number, obj: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • obj: Operation[]

          Returns boolean

    • Optional thisArg: any

    Returns Operation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Operation, index: number, obj: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • obj: Operation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Operation, index: number, array: Operation[]): void
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Operation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Operation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Operation, index: number, array: Operation[]): U
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Operation | undefined
  • Removes the last element from an array and returns it.

    Returns Operation | undefined

push

  • push(...items: Operation[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Operation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Operation
  • reduce(callbackfn: function, initialValue: Operation): Operation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Operation, currentValue: Operation, currentIndex: number, array: Operation[]): Operation
        • Parameters

          • previousValue: Operation
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns Operation

    Returns Operation

  • Parameters

    • callbackfn: function
        • (previousValue: Operation, currentValue: Operation, currentIndex: number, array: Operation[]): Operation
        • Parameters

          • previousValue: Operation
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns Operation

    • initialValue: Operation

    Returns Operation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          • previousValue: U
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Operation
  • reduceRight(callbackfn: function, initialValue: Operation): Operation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Operation, currentValue: Operation, currentIndex: number, array: Operation[]): Operation
        • Parameters

          • previousValue: Operation
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns Operation

    Returns Operation

  • Parameters

    • callbackfn: function
        • (previousValue: Operation, currentValue: Operation, currentIndex: number, array: Operation[]): Operation
        • Parameters

          • previousValue: Operation
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns Operation

    • initialValue: Operation

    Returns Operation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          • previousValue: U
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Operation[]
  • Reverses the elements in an Array.

    Returns Operation[]

shift

  • shift(): Operation | undefined
  • Removes the first element from an array and returns it.

    Returns Operation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Operation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Operation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Operation, index: number, array: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Operation[]
  • splice(start: number, deleteCount: number, ...items: Operation[]): Operation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Operation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Operation[]

      Elements to insert into the array in place of the deleted elements.

    Returns Operation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Operation[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Operation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Operation>
  • Returns an iterable of values in the array

    Returns IterableIterator<Operation>

type

type: object

className

className: string = "OperationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

Const PartnerInfo

PartnerInfo: object

Partner server information for the failover group.

id

id: string

Resource identifier of the partner server.

Optional location

location: undefined | string

Geo location of the partner server. NOTE: This property will not be serialized. It can only be populated by the server.

Optional replicationRole

Replication role of the partner server. Possible values include: 'Primary', 'Secondary' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PartnerInfo"

type

type: object

className

className: string = "PartnerInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

replicationRole

replicationRole: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "replicationRole"

type

type: object

name

name: "String" = "String"

Const PartnerRegionInfo

PartnerRegionInfo: object

Partner region information for the failover group.

Optional location

location: undefined | string

Geo location of the partner managed instances.

Optional replicationRole

Replication role of the partner managed instances. Possible values include: 'Primary', 'Secondary' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PartnerRegionInfo"

type

type: object

className

className: string = "PartnerRegionInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

replicationRole

replicationRole: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "replicationRole"

type

type: object

name

name: "String" = "String"

Const PerformanceLevelCapability

PerformanceLevelCapability: object

The performance level capability.

serializedName

serializedName: string = "PerformanceLevelCapability"

Optional unit

Unit type used to measure performance level. Possible values include: 'DTU', 'VCores' NOTE: This property will not be serialized. It can only be populated by the server.

Optional value

value: undefined | number

Performance level value. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "PerformanceLevelCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "Number" = "Number"

Const ProxyResource

ProxyResource: object

ARM proxy resource.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProxyResource"

type

type: object

className

className: string = "ProxyResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

Const RecommendedElasticPool

RecommendedElasticPool: object

Represents a recommended elastic pool.

Optional databaseDtuMax

databaseDtuMax: undefined | number

The maximum DTU for the database.

Optional databaseDtuMin

databaseDtuMin: undefined | number

The minimum DTU for the database.

Optional databaseEdition

databaseEdition: ElasticPoolEdition

The edition of the recommended elastic pool. The ElasticPoolEdition enumeration contains all the valid editions. Possible values include: 'Basic', 'Standard', 'Premium' NOTE: This property will not be serialized. It can only be populated by the server.

Optional databases

databases: TrackedResource[]

The list of databases in this pool. Expanded property NOTE: This property will not be serialized. It can only be populated by the server.

Optional dtu

dtu: undefined | number

The DTU for the recommended elastic pool.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxObservedDtu

maxObservedDtu: undefined | number

Gets maximum observed DTU. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxObservedStorageMB

maxObservedStorageMB: undefined | number

Gets maximum observed storage in megabytes. NOTE: This property will not be serialized. It can only be populated by the server.

Optional metrics

metrics: RecommendedElasticPoolMetric[]

The list of databases housed in the server. Expanded property NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional observationPeriodEnd

observationPeriodEnd: Date

The observation period start (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional observationPeriodStart

observationPeriodStart: Date

The observation period start (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RecommendedElasticPool"

Optional storageMB

storageMB: undefined | number

Gets storage size in megabytes.

type

type: object

className

className: string = "RecommendedElasticPool"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

databaseDtuMax

databaseDtuMax: object

serializedName

serializedName: string = "properties.databaseDtuMax"

type

type: object

name

name: "Number" = "Number"

databaseDtuMin

databaseDtuMin: object

serializedName

serializedName: string = "properties.databaseDtuMin"

type

type: object

name

name: "Number" = "Number"

databaseEdition

databaseEdition: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseEdition"

type

type: object

name

name: "String" = "String"

databases

databases: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databases"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TrackedResource"

name

name: "Composite" = "Composite"

dtu

dtu: object

serializedName

serializedName: string = "properties.dtu"

type

type: object

name

name: "Number" = "Number"

maxObservedDtu

maxObservedDtu: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maxObservedDtu"

type

type: object

name

name: "Number" = "Number"

maxObservedStorageMB

maxObservedStorageMB: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maxObservedStorageMB"

type

type: object

name

name: "Number" = "Number"

metrics

metrics: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.metrics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecommendedElasticPoolMetric"

name

name: "Composite" = "Composite"

observationPeriodEnd

observationPeriodEnd: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.observationPeriodEnd"

type

type: object

name

name: "DateTime" = "DateTime"

observationPeriodStart

observationPeriodStart: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.observationPeriodStart"

type

type: object

name

name: "DateTime" = "DateTime"

storageMB

storageMB: object

serializedName

serializedName: string = "properties.storageMB"

type

type: object

name

name: "Number" = "Number"

Const RecommendedElasticPoolListMetricsResult

RecommendedElasticPoolListMetricsResult: object
interface

Represents the response to a list recommended elastic pool metrics request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "RecommendedElasticPoolListMetricsResult"

__@iterator

  • __@iterator(): IterableIterator<RecommendedElasticPoolMetric>
  • Iterator

    Returns IterableIterator<RecommendedElasticPoolMetric>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<RecommendedElasticPoolMetric>[]): RecommendedElasticPoolMetric[]
  • concat(...items: (T | ConcatArray<T>)[]): RecommendedElasticPoolMetric[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RecommendedElasticPoolMetric>[]

      Additional items to add to the end of array1.

    Returns RecommendedElasticPoolMetric[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RecommendedElasticPoolMetric[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, RecommendedElasticPoolMetric]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RecommendedElasticPoolMetric]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: RecommendedElasticPoolMetric, index: number, array: RecommendedElasticPoolMetric[]): boolean
        • Parameters

          • value: RecommendedElasticPoolMetric
          • index: number
          • array: RecommendedElasticPoolMetric[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RecommendedElasticPoolMetric, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RecommendedElasticPoolMetric

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RecommendedElasticPoolMetric[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: RecommendedElasticPoolMetric

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RecommendedElasticPoolMetric, index: number, array: RecommendedElasticPoolMetric[]): boolean
        • Parameters

          • value: RecommendedElasticPoolMetric
          • index: number
          • array: RecommendedElasticPoolMetric[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RecommendedElasticPoolMetric, index: number, array: RecommendedElasticPoolMetric[]): any
        • Parameters

          • value: RecommendedElasticPoolMetric
          • index: number
          • array: RecommendedElasticPoolMetric[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RecommendedElasticPoolMetric[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RecommendedElasticPoolMetric | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: RecommendedElasticPoolMetric

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: RecommendedElasticPoolMetric, index: number, obj: RecommendedElasticPoolMetric[]): boolean
        • Parameters

          • this: void
          • value: RecommendedElasticPoolMetric
          • index: number
          • obj: RecommendedElasticPoolMetric[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: RecommendedElasticPoolMetric, index: number, obj: RecommendedElasticPoolMetric[]): boolean
        • Parameters

          • value: RecommendedElasticPoolMetric
          • index: number
          • obj: RecommendedElasticPoolMetric[]

          Returns boolean

    • Optional thisArg: any

    Returns RecommendedElasticPoolMetric | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: RecommendedElasticPoolMetric, index: number, obj: RecommendedElasticPoolMetric[]): boolean
        • Parameters

          • value: RecommendedElasticPoolMetric
          • index: number
          • obj: RecommendedElasticPoolMetric[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: RecommendedElasticPoolMetric, index: number, array: RecommendedElasticPoolMetric[]): void
        • Parameters

          • value: RecommendedElasticPoolMetric
          • index: number
          • array: RecommendedElasticPoolMetric[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RecommendedElasticPoolMetric, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RecommendedElasticPoolMetric

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RecommendedElasticPoolMetric, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RecommendedElasticPoolMetric

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RecommendedElasticPoolMetric, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RecommendedElasticPoolMetric

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: RecommendedElasticPoolMetric, index: number, array: RecommendedElasticPoolMetric[]): U
        • Parameters

          • value: RecommendedElasticPoolMetric
          • index: number
          • array: RecommendedElasticPoolMetric[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): RecommendedElasticPoolMetric | undefined
  • Removes the last element from an array and returns it.

    Returns RecommendedElasticPoolMetric | undefined

push

  • push(...items: RecommendedElasticPoolMetric[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: RecommendedElasticPoolMetric[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): RecommendedElasticPoolMetric
  • reduce(callbackfn: function, initialValue: RecommendedElasticPoolMetric): RecommendedElasticPoolMetric
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: RecommendedElasticPoolMetric, currentValue: RecommendedElasticPoolMetric, currentIndex: number, array: RecommendedElasticPoolMetric[]): RecommendedElasticPoolMetric
        • Parameters

          • previousValue: RecommendedElasticPoolMetric
          • currentValue: RecommendedElasticPoolMetric
          • currentIndex: number
          • array: RecommendedElasticPoolMetric[]

          Returns RecommendedElasticPoolMetric

    Returns RecommendedElasticPoolMetric

  • Parameters

    • callbackfn: function
        • (previousValue: RecommendedElasticPoolMetric, currentValue: RecommendedElasticPoolMetric, currentIndex: number, array: RecommendedElasticPoolMetric[]): RecommendedElasticPoolMetric
        • Parameters

          • previousValue: RecommendedElasticPoolMetric
          • currentValue: RecommendedElasticPoolMetric
          • currentIndex: number
          • array: RecommendedElasticPoolMetric[]

          Returns RecommendedElasticPoolMetric

    • initialValue: RecommendedElasticPoolMetric

    Returns RecommendedElasticPoolMetric

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RecommendedElasticPoolMetric, currentIndex: number, array: RecommendedElasticPoolMetric[]): U
        • Parameters

          • previousValue: U
          • currentValue: RecommendedElasticPoolMetric
          • currentIndex: number
          • array: RecommendedElasticPoolMetric[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RecommendedElasticPoolMetric
  • reduceRight(callbackfn: function, initialValue: RecommendedElasticPoolMetric): RecommendedElasticPoolMetric
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: RecommendedElasticPoolMetric, currentValue: RecommendedElasticPoolMetric, currentIndex: number, array: RecommendedElasticPoolMetric[]): RecommendedElasticPoolMetric
        • Parameters

          • previousValue: RecommendedElasticPoolMetric
          • currentValue: RecommendedElasticPoolMetric
          • currentIndex: number
          • array: RecommendedElasticPoolMetric[]

          Returns RecommendedElasticPoolMetric

    Returns RecommendedElasticPoolMetric

  • Parameters

    • callbackfn: function
        • (previousValue: RecommendedElasticPoolMetric, currentValue: RecommendedElasticPoolMetric, currentIndex: number, array: RecommendedElasticPoolMetric[]): RecommendedElasticPoolMetric
        • Parameters

          • previousValue: RecommendedElasticPoolMetric
          • currentValue: RecommendedElasticPoolMetric
          • currentIndex: number
          • array: RecommendedElasticPoolMetric[]

          Returns RecommendedElasticPoolMetric

    • initialValue: RecommendedElasticPoolMetric

    Returns RecommendedElasticPoolMetric

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RecommendedElasticPoolMetric, currentIndex: number, array: RecommendedElasticPoolMetric[]): U
        • Parameters

          • previousValue: U
          • currentValue: RecommendedElasticPoolMetric
          • currentIndex: number
          • array: RecommendedElasticPoolMetric[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): RecommendedElasticPoolMetric[]
  • Reverses the elements in an Array.

    Returns RecommendedElasticPoolMetric[]

shift

  • shift(): RecommendedElasticPoolMetric | undefined
  • Removes the first element from an array and returns it.

    Returns RecommendedElasticPoolMetric | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RecommendedElasticPoolMetric[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RecommendedElasticPoolMetric[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: RecommendedElasticPoolMetric, index: number, array: RecommendedElasticPoolMetric[]): boolean
        • Parameters

          • value: RecommendedElasticPoolMetric
          • index: number
          • array: RecommendedElasticPoolMetric[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): RecommendedElasticPoolMetric[]
  • splice(start: number, deleteCount: number, ...items: RecommendedElasticPoolMetric[]): RecommendedElasticPoolMetric[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RecommendedElasticPoolMetric[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RecommendedElasticPoolMetric[]

      Elements to insert into the array in place of the deleted elements.

    Returns RecommendedElasticPoolMetric[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: RecommendedElasticPoolMetric[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RecommendedElasticPoolMetric[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<RecommendedElasticPoolMetric>
  • Returns an iterable of values in the array

    Returns IterableIterator<RecommendedElasticPoolMetric>

type

type: object

className

className: string = "RecommendedElasticPoolListMetricsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecommendedElasticPoolMetric"

name

name: "Composite" = "Composite"

Const RecommendedElasticPoolListResult

RecommendedElasticPoolListResult: object
interface

Represents the response to a list recommended elastic pool request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "RecommendedElasticPoolListResult"

__@iterator

  • __@iterator(): IterableIterator<RecommendedElasticPool>
  • Iterator

    Returns IterableIterator<RecommendedElasticPool>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<RecommendedElasticPool>[]): RecommendedElasticPool[]
  • concat(...items: (T | ConcatArray<T>)[]): RecommendedElasticPool[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RecommendedElasticPool>[]

      Additional items to add to the end of array1.

    Returns RecommendedElasticPool[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RecommendedElasticPool[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, RecommendedElasticPool]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RecommendedElasticPool]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: RecommendedElasticPool, index: number, array: RecommendedElasticPool[]): boolean
        • Parameters

          • value: RecommendedElasticPool
          • index: number
          • array: RecommendedElasticPool[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RecommendedElasticPool, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RecommendedElasticPool

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RecommendedElasticPool[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: RecommendedElasticPool

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RecommendedElasticPool, index: number, array: RecommendedElasticPool[]): boolean
        • Parameters

          • value: RecommendedElasticPool
          • index: number
          • array: RecommendedElasticPool[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RecommendedElasticPool, index: number, array: RecommendedElasticPool[]): any
        • Parameters

          • value: RecommendedElasticPool
          • index: number
          • array: RecommendedElasticPool[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RecommendedElasticPool[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RecommendedElasticPool | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: RecommendedElasticPool

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: RecommendedElasticPool, index: number, obj: RecommendedElasticPool[]): boolean
        • Parameters

          • this: void
          • value: RecommendedElasticPool
          • index: number
          • obj: RecommendedElasticPool[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: RecommendedElasticPool, index: number, obj: RecommendedElasticPool[]): boolean
        • Parameters

          • value: RecommendedElasticPool
          • index: number
          • obj: RecommendedElasticPool[]

          Returns boolean

    • Optional thisArg: any

    Returns RecommendedElasticPool | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: RecommendedElasticPool, index: number, obj: RecommendedElasticPool[]): boolean
        • Parameters

          • value: RecommendedElasticPool
          • index: number
          • obj: RecommendedElasticPool[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: RecommendedElasticPool, index: number, array: RecommendedElasticPool[]): void
        • Parameters

          • value: RecommendedElasticPool
          • index: number
          • array: RecommendedElasticPool[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RecommendedElasticPool, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RecommendedElasticPool

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RecommendedElasticPool, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RecommendedElasticPool

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RecommendedElasticPool, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RecommendedElasticPool

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: RecommendedElasticPool, index: number, array: RecommendedElasticPool[]): U
        • Parameters

          • value: RecommendedElasticPool
          • index: number
          • array: RecommendedElasticPool[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): RecommendedElasticPool | undefined
  • Removes the last element from an array and returns it.

    Returns RecommendedElasticPool | undefined

push

  • push(...items: RecommendedElasticPool[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: RecommendedElasticPool[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): RecommendedElasticPool
  • reduce(callbackfn: function, initialValue: RecommendedElasticPool): RecommendedElasticPool
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: RecommendedElasticPool, currentValue: RecommendedElasticPool, currentIndex: number, array: RecommendedElasticPool[]): RecommendedElasticPool
        • Parameters

          • previousValue: RecommendedElasticPool
          • currentValue: RecommendedElasticPool
          • currentIndex: number
          • array: RecommendedElasticPool[]

          Returns RecommendedElasticPool

    Returns RecommendedElasticPool

  • Parameters

    • callbackfn: function
        • (previousValue: RecommendedElasticPool, currentValue: RecommendedElasticPool, currentIndex: number, array: RecommendedElasticPool[]): RecommendedElasticPool
        • Parameters

          • previousValue: RecommendedElasticPool
          • currentValue: RecommendedElasticPool
          • currentIndex: number
          • array: RecommendedElasticPool[]

          Returns RecommendedElasticPool

    • initialValue: RecommendedElasticPool

    Returns RecommendedElasticPool

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RecommendedElasticPool, currentIndex: number, array: RecommendedElasticPool[]): U
        • Parameters

          • previousValue: U
          • currentValue: RecommendedElasticPool
          • currentIndex: number
          • array: RecommendedElasticPool[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RecommendedElasticPool
  • reduceRight(callbackfn: function, initialValue: RecommendedElasticPool): RecommendedElasticPool
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: RecommendedElasticPool, currentValue: RecommendedElasticPool, currentIndex: number, array: RecommendedElasticPool[]): RecommendedElasticPool
        • Parameters

          • previousValue: RecommendedElasticPool
          • currentValue: RecommendedElasticPool
          • currentIndex: number
          • array: RecommendedElasticPool[]

          Returns RecommendedElasticPool

    Returns RecommendedElasticPool

  • Parameters

    • callbackfn: function
        • (previousValue: RecommendedElasticPool, currentValue: RecommendedElasticPool, currentIndex: number, array: RecommendedElasticPool[]): RecommendedElasticPool
        • Parameters

          • previousValue: RecommendedElasticPool
          • currentValue: RecommendedElasticPool
          • currentIndex: number
          • array: RecommendedElasticPool[]

          Returns RecommendedElasticPool

    • initialValue: RecommendedElasticPool

    Returns RecommendedElasticPool

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RecommendedElasticPool, currentIndex: number, array: RecommendedElasticPool[]): U
        • Parameters

          • previousValue: U
          • currentValue: RecommendedElasticPool
          • currentIndex: number
          • array: RecommendedElasticPool[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): RecommendedElasticPool[]
  • Reverses the elements in an Array.

    Returns RecommendedElasticPool[]

shift

  • shift(): RecommendedElasticPool | undefined
  • Removes the first element from an array and returns it.

    Returns RecommendedElasticPool | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RecommendedElasticPool[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RecommendedElasticPool[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: RecommendedElasticPool, index: number, array: RecommendedElasticPool[]): boolean
        • Parameters

          • value: RecommendedElasticPool
          • index: number
          • array: RecommendedElasticPool[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): RecommendedElasticPool[]
  • splice(start: number, deleteCount: number, ...items: RecommendedElasticPool[]): RecommendedElasticPool[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RecommendedElasticPool[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RecommendedElasticPool[]

      Elements to insert into the array in place of the deleted elements.

    Returns RecommendedElasticPool[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: RecommendedElasticPool[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RecommendedElasticPool[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<RecommendedElasticPool>
  • Returns an iterable of values in the array

    Returns IterableIterator<RecommendedElasticPool>

type

type: object

className

className: string = "RecommendedElasticPoolListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecommendedElasticPool"

name

name: "Composite" = "Composite"

Const RecommendedElasticPoolMetric

RecommendedElasticPoolMetric: object

Represents recommended elastic pool metric.

Optional dateTime

dateTime: Date

The time of metric (ISO8601 format).

Optional dtu

dtu: undefined | number

Gets or sets the DTUs (Database Transaction Units). See https://azure.microsoft.com/documentation/articles/sql-database-what-is-a-dtu/

serializedName

serializedName: string = "RecommendedElasticPoolMetric"

Optional sizeGB

sizeGB: undefined | number

Gets or sets size in gigabytes.

type

type: object

className

className: string = "RecommendedElasticPoolMetric"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dateTime

dateTime: object

serializedName

serializedName: string = "dateTime"

type

type: object

name

name: "DateTime" = "DateTime"

dtu

dtu: object

serializedName

serializedName: string = "dtu"

type

type: object

name

name: "Number" = "Number"

sizeGB

sizeGB: object

serializedName

serializedName: string = "sizeGB"

type

type: object

name

name: "Number" = "Number"

Const RecommendedIndex

RecommendedIndex: object

Represents a database recommended index.

Optional action

The proposed index action. You can create a missing index, drop an unused index, or rebuild an existing index to improve its performance. Possible values include: 'Create', 'Drop', 'Rebuild' NOTE: This property will not be serialized. It can only be populated by the server.

Optional columns

columns: string[]

Columns over which to build index NOTE: This property will not be serialized. It can only be populated by the server.

Optional created

created: Date

The UTC datetime showing when this resource was created (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional estimatedImpact

estimatedImpact: OperationImpact[]

The estimated impact of doing recommended index action. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional includedColumns

includedColumns: string[]

The list of column names to be included in the index NOTE: This property will not be serialized. It can only be populated by the server.

Optional indexScript

indexScript: undefined | string

The full build index script NOTE: This property will not be serialized. It can only be populated by the server.

Optional indexType

The type of index (CLUSTERED, NONCLUSTERED, COLUMNSTORE, CLUSTERED COLUMNSTORE). Possible values include: 'CLUSTERED', 'NONCLUSTERED', 'COLUMNSTORE', 'CLUSTERED COLUMNSTORE' NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModified

lastModified: Date

The UTC datetime of when was this resource last changed (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reportedImpact

reportedImpact: OperationImpact[]

The values reported after index action is complete. NOTE: This property will not be serialized. It can only be populated by the server.

Optional schema

schema: undefined | string

The schema where table to build index over resides NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RecommendedIndex"

Optional state

The current recommendation state. Possible values include: 'Active', 'Pending', 'Executing', 'Verifying', 'Pending Revert', 'Reverting', 'Reverted', 'Ignored', 'Expired', 'Blocked', 'Success' NOTE: This property will not be serialized. It can only be populated by the server.

Optional table

table: undefined | string

The table on which to build index. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "RecommendedIndex"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.action"

type

type: object

allowedValues

allowedValues: string[] = ["Create","Drop","Rebuild"]

name

name: "Enum" = "Enum"

columns

columns: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.columns"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

created

created: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

estimatedImpact

estimatedImpact: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.estimatedImpact"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OperationImpact"

name

name: "Composite" = "Composite"

includedColumns

includedColumns: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.includedColumns"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

indexScript

indexScript: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.indexScript"

type

type: object

name

name: "String" = "String"

indexType

indexType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.indexType"

type

type: object

allowedValues

allowedValues: string[] = ["CLUSTERED","NONCLUSTERED","COLUMNSTORE","CLUSTERED COLUMNSTORE"]

name

name: "Enum" = "Enum"

lastModified

lastModified: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

reportedImpact

reportedImpact: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.reportedImpact"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OperationImpact"

name

name: "Composite" = "Composite"

schema

schema: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.schema"

type

type: object

name

name: "String" = "String"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["Active","Pending","Executing","Verifying","Pending Revert","Reverting","Reverted","Ignored","Expired","Blocked","Success"]

name

name: "Enum" = "Enum"

table

table: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.table"

type

type: object

name

name: "String" = "String"

Const RecoverableDatabase

RecoverableDatabase: object

A recoverable database

Optional edition

edition: undefined | string

The edition of the database NOTE: This property will not be serialized. It can only be populated by the server.

Optional elasticPoolName

elasticPoolName: undefined | string

The elastic pool name of the database NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastAvailableBackupDate

lastAvailableBackupDate: Date

The last available backup date of the database (ISO8601 format) NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RecoverableDatabase"

Optional serviceLevelObjective

serviceLevelObjective: undefined | string

The service level objective name of the database NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "RecoverableDatabase"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

edition

edition: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.edition"

type

type: object

name

name: "String" = "String"

elasticPoolName

elasticPoolName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.elasticPoolName"

type

type: object

name

name: "String" = "String"

lastAvailableBackupDate

lastAvailableBackupDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastAvailableBackupDate"

type

type: object

name

name: "DateTime" = "DateTime"

serviceLevelObjective

serviceLevelObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serviceLevelObjective"

type

type: object

name

name: "String" = "String"

Const RecoverableDatabaseListResult

RecoverableDatabaseListResult: object
interface

The response to a list recoverable databases request

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "RecoverableDatabaseListResult"

__@iterator

  • __@iterator(): IterableIterator<RecoverableDatabase>
  • Iterator

    Returns IterableIterator<RecoverableDatabase>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<RecoverableDatabase>[]): RecoverableDatabase[]
  • concat(...items: (T | ConcatArray<T>)[]): RecoverableDatabase[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RecoverableDatabase>[]

      Additional items to add to the end of array1.

    Returns RecoverableDatabase[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RecoverableDatabase[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, RecoverableDatabase]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RecoverableDatabase]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: RecoverableDatabase, index: number, array: RecoverableDatabase[]): boolean
        • Parameters

          • value: RecoverableDatabase
          • index: number
          • array: RecoverableDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RecoverableDatabase, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RecoverableDatabase

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RecoverableDatabase[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: RecoverableDatabase

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RecoverableDatabase, index: number, array: RecoverableDatabase[]): boolean
        • Parameters

          • value: RecoverableDatabase
          • index: number
          • array: RecoverableDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RecoverableDatabase, index: number, array: RecoverableDatabase[]): any
        • Parameters

          • value: RecoverableDatabase
          • index: number
          • array: RecoverableDatabase[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RecoverableDatabase[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RecoverableDatabase | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: RecoverableDatabase

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: RecoverableDatabase, index: number, obj: RecoverableDatabase[]): boolean
        • Parameters

          • this: void
          • value: RecoverableDatabase
          • index: number
          • obj: RecoverableDatabase[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: RecoverableDatabase, index: number, obj: RecoverableDatabase[]): boolean
        • Parameters

          • value: RecoverableDatabase
          • index: number
          • obj: RecoverableDatabase[]

          Returns boolean

    • Optional thisArg: any

    Returns RecoverableDatabase | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: RecoverableDatabase, index: number, obj: RecoverableDatabase[]): boolean
        • Parameters

          • value: RecoverableDatabase
          • index: number
          • obj: RecoverableDatabase[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: RecoverableDatabase, index: number, array: RecoverableDatabase[]): void
        • Parameters

          • value: RecoverableDatabase
          • index: number
          • array: RecoverableDatabase[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RecoverableDatabase, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RecoverableDatabase

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RecoverableDatabase, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RecoverableDatabase

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RecoverableDatabase, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RecoverableDatabase

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: RecoverableDatabase, index: number, array: RecoverableDatabase[]): U
        • Parameters

          • value: RecoverableDatabase
          • index: number
          • array: RecoverableDatabase[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): RecoverableDatabase | undefined
  • Removes the last element from an array and returns it.

    Returns RecoverableDatabase | undefined

push

  • push(...items: RecoverableDatabase[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: RecoverableDatabase[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): RecoverableDatabase
  • reduce(callbackfn: function, initialValue: RecoverableDatabase): RecoverableDatabase
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: RecoverableDatabase, currentValue: RecoverableDatabase, currentIndex: number, array: RecoverableDatabase[]): RecoverableDatabase
        • Parameters

          • previousValue: RecoverableDatabase
          • currentValue: RecoverableDatabase
          • currentIndex: number
          • array: RecoverableDatabase[]

          Returns RecoverableDatabase

    Returns RecoverableDatabase

  • Parameters

    • callbackfn: function
        • (previousValue: RecoverableDatabase, currentValue: RecoverableDatabase, currentIndex: number, array: RecoverableDatabase[]): RecoverableDatabase
        • Parameters

          • previousValue: RecoverableDatabase
          • currentValue: RecoverableDatabase
          • currentIndex: number
          • array: RecoverableDatabase[]

          Returns RecoverableDatabase

    • initialValue: RecoverableDatabase

    Returns RecoverableDatabase

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RecoverableDatabase, currentIndex: number, array: RecoverableDatabase[]): U
        • Parameters

          • previousValue: U
          • currentValue: RecoverableDatabase
          • currentIndex: number
          • array: RecoverableDatabase[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RecoverableDatabase
  • reduceRight(callbackfn: function, initialValue: RecoverableDatabase): RecoverableDatabase
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: RecoverableDatabase, currentValue: RecoverableDatabase, currentIndex: number, array: RecoverableDatabase[]): RecoverableDatabase
        • Parameters

          • previousValue: RecoverableDatabase
          • currentValue: RecoverableDatabase
          • currentIndex: number
          • array: RecoverableDatabase[]

          Returns RecoverableDatabase

    Returns RecoverableDatabase

  • Parameters

    • callbackfn: function
        • (previousValue: RecoverableDatabase, currentValue: RecoverableDatabase, currentIndex: number, array: RecoverableDatabase[]): RecoverableDatabase
        • Parameters

          • previousValue: RecoverableDatabase
          • currentValue: RecoverableDatabase
          • currentIndex: number
          • array: RecoverableDatabase[]

          Returns RecoverableDatabase

    • initialValue: RecoverableDatabase

    Returns RecoverableDatabase

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RecoverableDatabase, currentIndex: number, array: RecoverableDatabase[]): U
        • Parameters

          • previousValue: U
          • currentValue: RecoverableDatabase
          • currentIndex: number
          • array: RecoverableDatabase[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): RecoverableDatabase[]
  • Reverses the elements in an Array.

    Returns RecoverableDatabase[]

shift

  • shift(): RecoverableDatabase | undefined
  • Removes the first element from an array and returns it.

    Returns RecoverableDatabase | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RecoverableDatabase[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RecoverableDatabase[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: RecoverableDatabase, index: number, array: RecoverableDatabase[]): boolean
        • Parameters

          • value: RecoverableDatabase
          • index: number
          • array: RecoverableDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): RecoverableDatabase[]
  • splice(start: number, deleteCount: number, ...items: RecoverableDatabase[]): RecoverableDatabase[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RecoverableDatabase[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RecoverableDatabase[]

      Elements to insert into the array in place of the deleted elements.

    Returns RecoverableDatabase[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: RecoverableDatabase[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RecoverableDatabase[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<RecoverableDatabase>
  • Returns an iterable of values in the array

    Returns IterableIterator<RecoverableDatabase>

type

type: object

className

className: string = "RecoverableDatabaseListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoverableDatabase"

name

name: "Composite" = "Composite"

Const RecoverableManagedDatabase

RecoverableManagedDatabase: object

A recoverable managed database resource.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastAvailableBackupDate

lastAvailableBackupDate: undefined | string

The last available backup date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RecoverableManagedDatabase"

type

type: object

className

className: string = "RecoverableManagedDatabase"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lastAvailableBackupDate

lastAvailableBackupDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastAvailableBackupDate"

type

type: object

name

name: "String" = "String"

Const RecoverableManagedDatabaseListResult

RecoverableManagedDatabaseListResult: object
interface

A list of recoverable managed databases.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RecoverableManagedDatabaseListResult"

__@iterator

  • __@iterator(): IterableIterator<RecoverableManagedDatabase>
  • Iterator

    Returns IterableIterator<RecoverableManagedDatabase>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<RecoverableManagedDatabase>[]): RecoverableManagedDatabase[]
  • concat(...items: (T | ConcatArray<T>)[]): RecoverableManagedDatabase[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RecoverableManagedDatabase>[]

      Additional items to add to the end of array1.

    Returns RecoverableManagedDatabase[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RecoverableManagedDatabase[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, RecoverableManagedDatabase]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RecoverableManagedDatabase]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: RecoverableManagedDatabase, index: number, array: RecoverableManagedDatabase[]): boolean
        • Parameters

          • value: RecoverableManagedDatabase
          • index: number
          • array: RecoverableManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RecoverableManagedDatabase, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RecoverableManagedDatabase

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RecoverableManagedDatabase[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: RecoverableManagedDatabase

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RecoverableManagedDatabase, index: number, array: RecoverableManagedDatabase[]): boolean
        • Parameters

          • value: RecoverableManagedDatabase
          • index: number
          • array: RecoverableManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RecoverableManagedDatabase, index: number, array: RecoverableManagedDatabase[]): any
        • Parameters

          • value: RecoverableManagedDatabase
          • index: number
          • array: RecoverableManagedDatabase[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RecoverableManagedDatabase[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RecoverableManagedDatabase | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: RecoverableManagedDatabase

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: RecoverableManagedDatabase, index: number, obj: RecoverableManagedDatabase[]): boolean
        • Parameters

          • this: void
          • value: RecoverableManagedDatabase
          • index: number
          • obj: RecoverableManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: RecoverableManagedDatabase, index: number, obj: RecoverableManagedDatabase[]): boolean
        • Parameters

          • value: RecoverableManagedDatabase
          • index: number
          • obj: RecoverableManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

    Returns RecoverableManagedDatabase | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: RecoverableManagedDatabase, index: number, obj: RecoverableManagedDatabase[]): boolean
        • Parameters

          • value: RecoverableManagedDatabase
          • index: number
          • obj: RecoverableManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: RecoverableManagedDatabase, index: number, array: RecoverableManagedDatabase[]): void
        • Parameters

          • value: RecoverableManagedDatabase
          • index: number
          • array: RecoverableManagedDatabase[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RecoverableManagedDatabase, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RecoverableManagedDatabase

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RecoverableManagedDatabase, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RecoverableManagedDatabase

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RecoverableManagedDatabase, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RecoverableManagedDatabase

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: RecoverableManagedDatabase, index: number, array: RecoverableManagedDatabase[]): U
        • Parameters

          • value: RecoverableManagedDatabase
          • index: number
          • array: RecoverableManagedDatabase[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): RecoverableManagedDatabase | undefined
  • Removes the last element from an array and returns it.

    Returns RecoverableManagedDatabase | undefined

push

  • push(...items: RecoverableManagedDatabase[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: RecoverableManagedDatabase[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): RecoverableManagedDatabase
  • reduce(callbackfn: function, initialValue: RecoverableManagedDatabase): RecoverableManagedDatabase
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: RecoverableManagedDatabase, currentValue: RecoverableManagedDatabase, currentIndex: number, array: RecoverableManagedDatabase[]): RecoverableManagedDatabase
        • Parameters

          • previousValue: RecoverableManagedDatabase
          • currentValue: RecoverableManagedDatabase
          • currentIndex: number
          • array: RecoverableManagedDatabase[]

          Returns RecoverableManagedDatabase

    Returns RecoverableManagedDatabase

  • Parameters

    • callbackfn: function
        • (previousValue: RecoverableManagedDatabase, currentValue: RecoverableManagedDatabase, currentIndex: number, array: RecoverableManagedDatabase[]): RecoverableManagedDatabase
        • Parameters

          • previousValue: RecoverableManagedDatabase
          • currentValue: RecoverableManagedDatabase
          • currentIndex: number
          • array: RecoverableManagedDatabase[]

          Returns RecoverableManagedDatabase

    • initialValue: RecoverableManagedDatabase

    Returns RecoverableManagedDatabase

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RecoverableManagedDatabase, currentIndex: number, array: RecoverableManagedDatabase[]): U
        • Parameters

          • previousValue: U
          • currentValue: RecoverableManagedDatabase
          • currentIndex: number
          • array: RecoverableManagedDatabase[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RecoverableManagedDatabase
  • reduceRight(callbackfn: function, initialValue: RecoverableManagedDatabase): RecoverableManagedDatabase
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: RecoverableManagedDatabase, currentValue: RecoverableManagedDatabase, currentIndex: number, array: RecoverableManagedDatabase[]): RecoverableManagedDatabase
        • Parameters

          • previousValue: RecoverableManagedDatabase
          • currentValue: RecoverableManagedDatabase
          • currentIndex: number
          • array: RecoverableManagedDatabase[]

          Returns RecoverableManagedDatabase

    Returns RecoverableManagedDatabase

  • Parameters

    • callbackfn: function
        • (previousValue: RecoverableManagedDatabase, currentValue: RecoverableManagedDatabase, currentIndex: number, array: RecoverableManagedDatabase[]): RecoverableManagedDatabase
        • Parameters

          • previousValue: RecoverableManagedDatabase
          • currentValue: RecoverableManagedDatabase
          • currentIndex: number
          • array: RecoverableManagedDatabase[]

          Returns RecoverableManagedDatabase

    • initialValue: RecoverableManagedDatabase

    Returns RecoverableManagedDatabase

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RecoverableManagedDatabase, currentIndex: number, array: RecoverableManagedDatabase[]): U
        • Parameters

          • previousValue: U
          • currentValue: RecoverableManagedDatabase
          • currentIndex: number
          • array: RecoverableManagedDatabase[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): RecoverableManagedDatabase[]
  • Reverses the elements in an Array.

    Returns RecoverableManagedDatabase[]

shift

  • shift(): RecoverableManagedDatabase | undefined
  • Removes the first element from an array and returns it.

    Returns RecoverableManagedDatabase | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RecoverableManagedDatabase[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RecoverableManagedDatabase[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: RecoverableManagedDatabase, index: number, array: RecoverableManagedDatabase[]): boolean
        • Parameters

          • value: RecoverableManagedDatabase
          • index: number
          • array: RecoverableManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): RecoverableManagedDatabase[]
  • splice(start: number, deleteCount: number, ...items: RecoverableManagedDatabase[]): RecoverableManagedDatabase[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RecoverableManagedDatabase[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RecoverableManagedDatabase[]

      Elements to insert into the array in place of the deleted elements.

    Returns RecoverableManagedDatabase[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: RecoverableManagedDatabase[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RecoverableManagedDatabase[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<RecoverableManagedDatabase>
  • Returns an iterable of values in the array

    Returns IterableIterator<RecoverableManagedDatabase>

type

type: object

className

className: string = "RecoverableManagedDatabaseListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoverableManagedDatabase"

name

name: "Composite" = "Composite"

Const ReplicationLink

ReplicationLink: object

Represents a database replication link.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isTerminationAllowed

isTerminationAllowed: undefined | false | true

Legacy value indicating whether termination is allowed. Currently always returns true. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

Location of the server that contains this firewall rule. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional partnerDatabase

partnerDatabase: undefined | string

The name of the partner database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional partnerLocation

partnerLocation: undefined | string

The Azure Region of the partner database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional partnerRole

partnerRole: ReplicationRole

The role of the partner database in the replication link. Possible values include: 'Primary', 'Secondary', 'NonReadableSecondary', 'Source', 'Copy' NOTE: This property will not be serialized. It can only be populated by the server.

Optional partnerServer

partnerServer: undefined | string

The name of the server hosting the partner database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional percentComplete

percentComplete: undefined | number

The percentage of seeding complete for the replication link. NOTE: This property will not be serialized. It can only be populated by the server.

Optional replicationMode

replicationMode: undefined | string

Replication mode of this replication link. NOTE: This property will not be serialized. It can only be populated by the server.

Optional replicationState

replicationState: ReplicationState

The replication state for the replication link. Possible values include: 'PENDING', 'SEEDING', 'CATCH_UP', 'SUSPENDED' NOTE: This property will not be serialized. It can only be populated by the server.

Optional role

The role of the database in the replication link. Possible values include: 'Primary', 'Secondary', 'NonReadableSecondary', 'Source', 'Copy' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ReplicationLink"

Optional startTime

startTime: Date

The start time for the replication link. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ReplicationLink"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isTerminationAllowed

isTerminationAllowed: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isTerminationAllowed"

type

type: object

name

name: "Boolean" = "Boolean"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

partnerDatabase

partnerDatabase: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.partnerDatabase"

type

type: object

name

name: "String" = "String"

partnerLocation

partnerLocation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.partnerLocation"

type

type: object

name

name: "String" = "String"

partnerRole

partnerRole: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.partnerRole"

type

type: object

allowedValues

allowedValues: string[] = ["Primary","Secondary","NonReadableSecondary","Source","Copy"]

name

name: "Enum" = "Enum"

partnerServer

partnerServer: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.partnerServer"

type

type: object

name

name: "String" = "String"

percentComplete

percentComplete: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.percentComplete"

type

type: object

name

name: "Number" = "Number"

replicationMode

replicationMode: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.replicationMode"

type

type: object

name

name: "String" = "String"

replicationState

replicationState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.replicationState"

type

type: object

name

name: "String" = "String"

role

role: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.role"

type

type: object

allowedValues

allowedValues: string[] = ["Primary","Secondary","NonReadableSecondary","Source","Copy"]

name

name: "Enum" = "Enum"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const ReplicationLinkListResult

ReplicationLinkListResult: object
interface

Represents the response to a List database replication link request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ReplicationLinkListResult"

__@iterator

  • __@iterator(): IterableIterator<ReplicationLink>
  • Iterator

    Returns IterableIterator<ReplicationLink>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ReplicationLink>[]): ReplicationLink[]
  • concat(...items: (T | ConcatArray<T>)[]): ReplicationLink[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ReplicationLink>[]

      Additional items to add to the end of array1.

    Returns ReplicationLink[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ReplicationLink[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ReplicationLink]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ReplicationLink]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ReplicationLink, index: number, array: ReplicationLink[]): boolean
        • Parameters

          • value: ReplicationLink
          • index: number
          • array: ReplicationLink[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ReplicationLink, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ReplicationLink

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ReplicationLink[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ReplicationLink

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ReplicationLink, index: number, array: ReplicationLink[]): boolean
        • Parameters

          • value: ReplicationLink
          • index: number
          • array: ReplicationLink[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ReplicationLink, index: number, array: ReplicationLink[]): any
        • Parameters

          • value: ReplicationLink
          • index: number
          • array: ReplicationLink[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ReplicationLink[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ReplicationLink | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ReplicationLink

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ReplicationLink, index: number, obj: ReplicationLink[]): boolean
        • Parameters

          • this: void
          • value: ReplicationLink
          • index: number
          • obj: ReplicationLink[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ReplicationLink, index: number, obj: ReplicationLink[]): boolean
        • Parameters

          • value: ReplicationLink
          • index: number
          • obj: ReplicationLink[]

          Returns boolean

    • Optional thisArg: any

    Returns ReplicationLink | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ReplicationLink, index: number, obj: ReplicationLink[]): boolean
        • Parameters

          • value: ReplicationLink
          • index: number
          • obj: ReplicationLink[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ReplicationLink, index: number, array: ReplicationLink[]): void
        • Parameters

          • value: ReplicationLink
          • index: number
          • array: ReplicationLink[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ReplicationLink, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ReplicationLink

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ReplicationLink, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ReplicationLink

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ReplicationLink, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ReplicationLink

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ReplicationLink, index: number, array: ReplicationLink[]): U
        • Parameters

          • value: ReplicationLink
          • index: number
          • array: ReplicationLink[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ReplicationLink | undefined
  • Removes the last element from an array and returns it.

    Returns ReplicationLink | undefined

push

  • push(...items: ReplicationLink[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ReplicationLink[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ReplicationLink
  • reduce(callbackfn: function, initialValue: ReplicationLink): ReplicationLink
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ReplicationLink, currentValue: ReplicationLink, currentIndex: number, array: ReplicationLink[]): ReplicationLink
        • Parameters

          • previousValue: ReplicationLink
          • currentValue: ReplicationLink
          • currentIndex: number
          • array: ReplicationLink[]

          Returns ReplicationLink

    Returns ReplicationLink

  • Parameters

    • callbackfn: function
        • (previousValue: ReplicationLink, currentValue: ReplicationLink, currentIndex: number, array: ReplicationLink[]): ReplicationLink
        • Parameters

          • previousValue: ReplicationLink
          • currentValue: ReplicationLink
          • currentIndex: number
          • array: ReplicationLink[]

          Returns ReplicationLink

    • initialValue: ReplicationLink

    Returns ReplicationLink

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ReplicationLink, currentIndex: number, array: ReplicationLink[]): U
        • Parameters

          • previousValue: U
          • currentValue: ReplicationLink
          • currentIndex: number
          • array: ReplicationLink[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ReplicationLink
  • reduceRight(callbackfn: function, initialValue: ReplicationLink): ReplicationLink
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ReplicationLink, currentValue: ReplicationLink, currentIndex: number, array: ReplicationLink[]): ReplicationLink
        • Parameters

          • previousValue: ReplicationLink
          • currentValue: ReplicationLink
          • currentIndex: number
          • array: ReplicationLink[]

          Returns ReplicationLink

    Returns ReplicationLink

  • Parameters

    • callbackfn: function
        • (previousValue: ReplicationLink, currentValue: ReplicationLink, currentIndex: number, array: ReplicationLink[]): ReplicationLink
        • Parameters

          • previousValue: ReplicationLink
          • currentValue: ReplicationLink
          • currentIndex: number
          • array: ReplicationLink[]

          Returns ReplicationLink

    • initialValue: ReplicationLink

    Returns ReplicationLink

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ReplicationLink, currentIndex: number, array: ReplicationLink[]): U
        • Parameters

          • previousValue: U
          • currentValue: ReplicationLink
          • currentIndex: number
          • array: ReplicationLink[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ReplicationLink[]
  • Reverses the elements in an Array.

    Returns ReplicationLink[]

shift

  • shift(): ReplicationLink | undefined
  • Removes the first element from an array and returns it.

    Returns ReplicationLink | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ReplicationLink[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ReplicationLink[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ReplicationLink, index: number, array: ReplicationLink[]): boolean
        • Parameters

          • value: ReplicationLink
          • index: number
          • array: ReplicationLink[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ReplicationLink[]
  • splice(start: number, deleteCount: number, ...items: ReplicationLink[]): ReplicationLink[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ReplicationLink[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ReplicationLink[]

      Elements to insert into the array in place of the deleted elements.

    Returns ReplicationLink[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ReplicationLink[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ReplicationLink[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ReplicationLink>
  • Returns an iterable of values in the array

    Returns IterableIterator<ReplicationLink>

type

type: object

className

className: string = "ReplicationLinkListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ReplicationLink"

name

name: "Composite" = "Composite"

Const Resource

Resource: object

ARM resource.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Resource"

type

type: object

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ResourceIdentity

ResourceIdentity: object

Azure Active Directory identity configuration for a resource.

Optional principalId

principalId: undefined | string

The Azure Active Directory principal id. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceIdentity"

Optional tenantId

tenantId: undefined | string

The Azure Active Directory tenant id. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. Possible values include: 'SystemAssigned'

className

className: string = "ResourceIdentity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

principalId

principalId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "Uuid" = "Uuid"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "Uuid" = "Uuid"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ResourceMoveDefinition

ResourceMoveDefinition: object

Contains the information necessary to perform a resource move (rename).

id

id: string

The target ID for the resource

serializedName

serializedName: string = "ResourceMoveDefinition"

type

type: object

className

className: string = "ResourceMoveDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const RestorableDroppedDatabase

RestorableDroppedDatabase: object

A restorable dropped database

Optional creationDate

creationDate: Date

The creation date of the database (ISO8601 format) NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseName

databaseName: undefined | string

The name of the database NOTE: This property will not be serialized. It can only be populated by the server.

Optional deletionDate

deletionDate: Date

The deletion date of the database (ISO8601 format) NOTE: This property will not be serialized. It can only be populated by the server.

Optional earliestRestoreDate

earliestRestoreDate: Date

The earliest restore date of the database (ISO8601 format) NOTE: This property will not be serialized. It can only be populated by the server.

Optional edition

edition: undefined | string

The edition of the database NOTE: This property will not be serialized. It can only be populated by the server.

Optional elasticPoolName

elasticPoolName: undefined | string

The elastic pool name of the database NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The geo-location where the resource lives NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxSizeBytes

maxSizeBytes: undefined | string

The max size in bytes of the database NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RestorableDroppedDatabase"

Optional serviceLevelObjective

serviceLevelObjective: undefined | string

The service level objective name of the database NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "RestorableDroppedDatabase"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationDate

creationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationDate"

type

type: object

name

name: "DateTime" = "DateTime"

databaseName

databaseName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseName"

type

type: object

name

name: "String" = "String"

deletionDate

deletionDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.deletionDate"

type

type: object

name

name: "DateTime" = "DateTime"

earliestRestoreDate

earliestRestoreDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.earliestRestoreDate"

type

type: object

name

name: "DateTime" = "DateTime"

edition

edition: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.edition"

type

type: object

name

name: "String" = "String"

elasticPoolName

elasticPoolName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.elasticPoolName"

type

type: object

name

name: "String" = "String"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

maxSizeBytes

maxSizeBytes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maxSizeBytes"

type

type: object

name

name: "String" = "String"

serviceLevelObjective

serviceLevelObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serviceLevelObjective"

type

type: object

name

name: "String" = "String"

Const RestorableDroppedDatabaseListResult

RestorableDroppedDatabaseListResult: object
interface

The response to a list restorable dropped databases request

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "RestorableDroppedDatabaseListResult"

__@iterator

  • __@iterator(): IterableIterator<RestorableDroppedDatabase>
  • Iterator

    Returns IterableIterator<RestorableDroppedDatabase>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<RestorableDroppedDatabase>[]): RestorableDroppedDatabase[]
  • concat(...items: (T | ConcatArray<T>)[]): RestorableDroppedDatabase[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RestorableDroppedDatabase>[]

      Additional items to add to the end of array1.

    Returns RestorableDroppedDatabase[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RestorableDroppedDatabase[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, RestorableDroppedDatabase]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RestorableDroppedDatabase]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: RestorableDroppedDatabase, index: number, array: RestorableDroppedDatabase[]): boolean
        • Parameters

          • value: RestorableDroppedDatabase
          • index: number
          • array: RestorableDroppedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RestorableDroppedDatabase, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RestorableDroppedDatabase

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RestorableDroppedDatabase[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: RestorableDroppedDatabase

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RestorableDroppedDatabase, index: number, array: RestorableDroppedDatabase[]): boolean
        • Parameters

          • value: RestorableDroppedDatabase
          • index: number
          • array: RestorableDroppedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RestorableDroppedDatabase, index: number, array: RestorableDroppedDatabase[]): any
        • Parameters

          • value: RestorableDroppedDatabase
          • index: number
          • array: RestorableDroppedDatabase[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RestorableDroppedDatabase[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RestorableDroppedDatabase | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: RestorableDroppedDatabase

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: RestorableDroppedDatabase, index: number, obj: RestorableDroppedDatabase[]): boolean
        • Parameters

          • this: void
          • value: RestorableDroppedDatabase
          • index: number
          • obj: RestorableDroppedDatabase[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: RestorableDroppedDatabase, index: number, obj: RestorableDroppedDatabase[]): boolean
        • Parameters

          • value: RestorableDroppedDatabase
          • index: number
          • obj: RestorableDroppedDatabase[]

          Returns boolean

    • Optional thisArg: any

    Returns RestorableDroppedDatabase | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: RestorableDroppedDatabase, index: number, obj: RestorableDroppedDatabase[]): boolean
        • Parameters

          • value: RestorableDroppedDatabase
          • index: number
          • obj: RestorableDroppedDatabase[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: RestorableDroppedDatabase, index: number, array: RestorableDroppedDatabase[]): void
        • Parameters

          • value: RestorableDroppedDatabase
          • index: number
          • array: RestorableDroppedDatabase[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RestorableDroppedDatabase, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RestorableDroppedDatabase

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RestorableDroppedDatabase, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RestorableDroppedDatabase

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RestorableDroppedDatabase, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RestorableDroppedDatabase

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: RestorableDroppedDatabase, index: number, array: RestorableDroppedDatabase[]): U
        • Parameters

          • value: RestorableDroppedDatabase
          • index: number
          • array: RestorableDroppedDatabase[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): RestorableDroppedDatabase | undefined
  • Removes the last element from an array and returns it.

    Returns RestorableDroppedDatabase | undefined

push

  • push(...items: RestorableDroppedDatabase[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: RestorableDroppedDatabase[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): RestorableDroppedDatabase
  • reduce(callbackfn: function, initialValue: RestorableDroppedDatabase): RestorableDroppedDatabase
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: RestorableDroppedDatabase, currentValue: RestorableDroppedDatabase, currentIndex: number, array: RestorableDroppedDatabase[]): RestorableDroppedDatabase
        • Parameters

          • previousValue: RestorableDroppedDatabase
          • currentValue: RestorableDroppedDatabase
          • currentIndex: number
          • array: RestorableDroppedDatabase[]

          Returns RestorableDroppedDatabase

    Returns RestorableDroppedDatabase

  • Parameters

    • callbackfn: function
        • (previousValue: RestorableDroppedDatabase, currentValue: RestorableDroppedDatabase, currentIndex: number, array: RestorableDroppedDatabase[]): RestorableDroppedDatabase
        • Parameters

          • previousValue: RestorableDroppedDatabase
          • currentValue: RestorableDroppedDatabase
          • currentIndex: number
          • array: RestorableDroppedDatabase[]

          Returns RestorableDroppedDatabase

    • initialValue: RestorableDroppedDatabase

    Returns RestorableDroppedDatabase

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RestorableDroppedDatabase, currentIndex: number, array: RestorableDroppedDatabase[]): U
        • Parameters

          • previousValue: U
          • currentValue: RestorableDroppedDatabase
          • currentIndex: number
          • array: RestorableDroppedDatabase[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RestorableDroppedDatabase
  • reduceRight(callbackfn: function, initialValue: RestorableDroppedDatabase): RestorableDroppedDatabase
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: RestorableDroppedDatabase, currentValue: RestorableDroppedDatabase, currentIndex: number, array: RestorableDroppedDatabase[]): RestorableDroppedDatabase
        • Parameters

          • previousValue: RestorableDroppedDatabase
          • currentValue: RestorableDroppedDatabase
          • currentIndex: number
          • array: RestorableDroppedDatabase[]

          Returns RestorableDroppedDatabase

    Returns RestorableDroppedDatabase

  • Parameters

    • callbackfn: function
        • (previousValue: RestorableDroppedDatabase, currentValue: RestorableDroppedDatabase, currentIndex: number, array: RestorableDroppedDatabase[]): RestorableDroppedDatabase
        • Parameters

          • previousValue: RestorableDroppedDatabase
          • currentValue: RestorableDroppedDatabase
          • currentIndex: number
          • array: RestorableDroppedDatabase[]

          Returns RestorableDroppedDatabase

    • initialValue: RestorableDroppedDatabase

    Returns RestorableDroppedDatabase

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RestorableDroppedDatabase, currentIndex: number, array: RestorableDroppedDatabase[]): U
        • Parameters

          • previousValue: U
          • currentValue: RestorableDroppedDatabase
          • currentIndex: number
          • array: RestorableDroppedDatabase[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): RestorableDroppedDatabase[]
  • Reverses the elements in an Array.

    Returns RestorableDroppedDatabase[]

shift

  • shift(): RestorableDroppedDatabase | undefined
  • Removes the first element from an array and returns it.

    Returns RestorableDroppedDatabase | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RestorableDroppedDatabase[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RestorableDroppedDatabase[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: RestorableDroppedDatabase, index: number, array: RestorableDroppedDatabase[]): boolean
        • Parameters

          • value: RestorableDroppedDatabase
          • index: number
          • array: RestorableDroppedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): RestorableDroppedDatabase[]
  • splice(start: number, deleteCount: number, ...items: RestorableDroppedDatabase[]): RestorableDroppedDatabase[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RestorableDroppedDatabase[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RestorableDroppedDatabase[]

      Elements to insert into the array in place of the deleted elements.

    Returns RestorableDroppedDatabase[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: RestorableDroppedDatabase[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RestorableDroppedDatabase[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<RestorableDroppedDatabase>
  • Returns an iterable of values in the array

    Returns IterableIterator<RestorableDroppedDatabase>

type

type: object

className

className: string = "RestorableDroppedDatabaseListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RestorableDroppedDatabase"

name

name: "Composite" = "Composite"

Const RestorableDroppedManagedDatabase

RestorableDroppedManagedDatabase: object

A restorable dropped managed database resource.

Optional creationDate

creationDate: Date

The creation date of the database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseName

databaseName: undefined | string

The name of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional deletionDate

deletionDate: Date

The deletion date of the database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional earliestRestoreDate

earliestRestoreDate: Date

The earliest restore date of the database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RestorableDroppedManagedDatabase"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "RestorableDroppedManagedDatabase"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationDate

creationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationDate"

type

type: object

name

name: "DateTime" = "DateTime"

databaseName

databaseName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseName"

type

type: object

name

name: "String" = "String"

deletionDate

deletionDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.deletionDate"

type

type: object

name

name: "DateTime" = "DateTime"

earliestRestoreDate

earliestRestoreDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.earliestRestoreDate"

type

type: object

name

name: "DateTime" = "DateTime"

Const RestorableDroppedManagedDatabaseListResult

RestorableDroppedManagedDatabaseListResult: object
interface

A list of restorable dropped managed databases.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RestorableDroppedManagedDatabaseListResult"

__@iterator

  • __@iterator(): IterableIterator<RestorableDroppedManagedDatabase>
  • Iterator

    Returns IterableIterator<RestorableDroppedManagedDatabase>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<RestorableDroppedManagedDatabase>[]): RestorableDroppedManagedDatabase[]
  • concat(...items: (T | ConcatArray<T>)[]): RestorableDroppedManagedDatabase[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RestorableDroppedManagedDatabase>[]

      Additional items to add to the end of array1.

    Returns RestorableDroppedManagedDatabase[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RestorableDroppedManagedDatabase[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, RestorableDroppedManagedDatabase]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RestorableDroppedManagedDatabase]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: RestorableDroppedManagedDatabase, index: number, array: RestorableDroppedManagedDatabase[]): boolean
        • Parameters

          • value: RestorableDroppedManagedDatabase
          • index: number
          • array: RestorableDroppedManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RestorableDroppedManagedDatabase, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RestorableDroppedManagedDatabase

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RestorableDroppedManagedDatabase[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: RestorableDroppedManagedDatabase

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RestorableDroppedManagedDatabase, index: number, array: RestorableDroppedManagedDatabase[]): boolean
        • Parameters

          • value: RestorableDroppedManagedDatabase
          • index: number
          • array: RestorableDroppedManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RestorableDroppedManagedDatabase, index: number, array: RestorableDroppedManagedDatabase[]): any
        • Parameters

          • value: RestorableDroppedManagedDatabase
          • index: number
          • array: RestorableDroppedManagedDatabase[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RestorableDroppedManagedDatabase[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RestorableDroppedManagedDatabase | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: RestorableDroppedManagedDatabase

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: RestorableDroppedManagedDatabase, index: number, obj: RestorableDroppedManagedDatabase[]): boolean
        • Parameters

          • this: void
          • value: RestorableDroppedManagedDatabase
          • index: number
          • obj: RestorableDroppedManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: RestorableDroppedManagedDatabase, index: number, obj: RestorableDroppedManagedDatabase[]): boolean
        • Parameters

          • value: RestorableDroppedManagedDatabase
          • index: number
          • obj: RestorableDroppedManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

    Returns RestorableDroppedManagedDatabase | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: RestorableDroppedManagedDatabase, index: number, obj: RestorableDroppedManagedDatabase[]): boolean
        • Parameters

          • value: RestorableDroppedManagedDatabase
          • index: number
          • obj: RestorableDroppedManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: RestorableDroppedManagedDatabase, index: number, array: RestorableDroppedManagedDatabase[]): void
        • Parameters

          • value: RestorableDroppedManagedDatabase
          • index: number
          • array: RestorableDroppedManagedDatabase[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RestorableDroppedManagedDatabase, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RestorableDroppedManagedDatabase

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RestorableDroppedManagedDatabase, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RestorableDroppedManagedDatabase

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RestorableDroppedManagedDatabase, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RestorableDroppedManagedDatabase

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: RestorableDroppedManagedDatabase, index: number, array: RestorableDroppedManagedDatabase[]): U
        • Parameters

          • value: RestorableDroppedManagedDatabase
          • index: number
          • array: RestorableDroppedManagedDatabase[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): RestorableDroppedManagedDatabase | undefined
  • Removes the last element from an array and returns it.

    Returns RestorableDroppedManagedDatabase | undefined

push

  • push(...items: RestorableDroppedManagedDatabase[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: RestorableDroppedManagedDatabase[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): RestorableDroppedManagedDatabase
  • reduce(callbackfn: function, initialValue: RestorableDroppedManagedDatabase): RestorableDroppedManagedDatabase
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: RestorableDroppedManagedDatabase, currentValue: RestorableDroppedManagedDatabase, currentIndex: number, array: RestorableDroppedManagedDatabase[]): RestorableDroppedManagedDatabase
        • Parameters

          • previousValue: RestorableDroppedManagedDatabase
          • currentValue: RestorableDroppedManagedDatabase
          • currentIndex: number
          • array: RestorableDroppedManagedDatabase[]

          Returns RestorableDroppedManagedDatabase

    Returns RestorableDroppedManagedDatabase

  • Parameters

    • callbackfn: function
        • (previousValue: RestorableDroppedManagedDatabase, currentValue: RestorableDroppedManagedDatabase, currentIndex: number, array: RestorableDroppedManagedDatabase[]): RestorableDroppedManagedDatabase
        • Parameters

          • previousValue: RestorableDroppedManagedDatabase
          • currentValue: RestorableDroppedManagedDatabase
          • currentIndex: number
          • array: RestorableDroppedManagedDatabase[]

          Returns RestorableDroppedManagedDatabase

    • initialValue: RestorableDroppedManagedDatabase

    Returns RestorableDroppedManagedDatabase

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RestorableDroppedManagedDatabase, currentIndex: number, array: RestorableDroppedManagedDatabase[]): U
        • Parameters

          • previousValue: U
          • currentValue: RestorableDroppedManagedDatabase
          • currentIndex: number
          • array: RestorableDroppedManagedDatabase[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RestorableDroppedManagedDatabase
  • reduceRight(callbackfn: function, initialValue: RestorableDroppedManagedDatabase): RestorableDroppedManagedDatabase
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: RestorableDroppedManagedDatabase, currentValue: RestorableDroppedManagedDatabase, currentIndex: number, array: RestorableDroppedManagedDatabase[]): RestorableDroppedManagedDatabase
        • Parameters

          • previousValue: RestorableDroppedManagedDatabase
          • currentValue: RestorableDroppedManagedDatabase
          • currentIndex: number
          • array: RestorableDroppedManagedDatabase[]

          Returns RestorableDroppedManagedDatabase

    Returns RestorableDroppedManagedDatabase

  • Parameters

    • callbackfn: function
        • (previousValue: RestorableDroppedManagedDatabase, currentValue: RestorableDroppedManagedDatabase, currentIndex: number, array: RestorableDroppedManagedDatabase[]): RestorableDroppedManagedDatabase
        • Parameters

          • previousValue: RestorableDroppedManagedDatabase
          • currentValue: RestorableDroppedManagedDatabase
          • currentIndex: number
          • array: RestorableDroppedManagedDatabase[]

          Returns RestorableDroppedManagedDatabase

    • initialValue: RestorableDroppedManagedDatabase

    Returns RestorableDroppedManagedDatabase

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RestorableDroppedManagedDatabase, currentIndex: number, array: RestorableDroppedManagedDatabase[]): U
        • Parameters

          • previousValue: U
          • currentValue: RestorableDroppedManagedDatabase
          • currentIndex: number
          • array: RestorableDroppedManagedDatabase[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): RestorableDroppedManagedDatabase[]
  • Reverses the elements in an Array.

    Returns RestorableDroppedManagedDatabase[]

shift

  • shift(): RestorableDroppedManagedDatabase | undefined
  • Removes the first element from an array and returns it.

    Returns RestorableDroppedManagedDatabase | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RestorableDroppedManagedDatabase[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RestorableDroppedManagedDatabase[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: RestorableDroppedManagedDatabase, index: number, array: RestorableDroppedManagedDatabase[]): boolean
        • Parameters

          • value: RestorableDroppedManagedDatabase
          • index: number
          • array: RestorableDroppedManagedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): RestorableDroppedManagedDatabase[]
  • splice(start: number, deleteCount: number, ...items: RestorableDroppedManagedDatabase[]): RestorableDroppedManagedDatabase[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RestorableDroppedManagedDatabase[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RestorableDroppedManagedDatabase[]

      Elements to insert into the array in place of the deleted elements.

    Returns RestorableDroppedManagedDatabase[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: RestorableDroppedManagedDatabase[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RestorableDroppedManagedDatabase[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<RestorableDroppedManagedDatabase>
  • Returns an iterable of values in the array

    Returns IterableIterator<RestorableDroppedManagedDatabase>

type

type: object

className

className: string = "RestorableDroppedManagedDatabaseListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RestorableDroppedManagedDatabase"

name

name: "Composite" = "Composite"

Const RestorePoint

RestorePoint: object

Database restore points.

Optional earliestRestoreDate

earliestRestoreDate: Date

The earliest time to which this database can be restored NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

Resource location. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional restorePointCreationDate

restorePointCreationDate: Date

The time the backup was taken NOTE: This property will not be serialized. It can only be populated by the server.

Optional restorePointLabel

restorePointLabel: undefined | string

The label of restore point for backup request by user NOTE: This property will not be serialized. It can only be populated by the server.

Optional restorePointType

restorePointType: RestorePointType

The type of restore point. Possible values include: 'CONTINUOUS', 'DISCRETE' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RestorePoint"

type

type: object

className

className: string = "RestorePoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

earliestRestoreDate

earliestRestoreDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.earliestRestoreDate"

type

type: object

name

name: "DateTime" = "DateTime"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

restorePointCreationDate

restorePointCreationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.restorePointCreationDate"

type

type: object

name

name: "DateTime" = "DateTime"

restorePointLabel

restorePointLabel: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.restorePointLabel"

type

type: object

name

name: "String" = "String"

restorePointType

restorePointType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.restorePointType"

type

type: object

allowedValues

allowedValues: string[] = ["CONTINUOUS","DISCRETE"]

name

name: "Enum" = "Enum"

Const RestorePointListResult

RestorePointListResult: object
interface

A list of long term retention backups.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RestorePointListResult"

__@iterator

  • __@iterator(): IterableIterator<RestorePoint>
  • Iterator

    Returns IterableIterator<RestorePoint>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<RestorePoint>[]): RestorePoint[]
  • concat(...items: (T | ConcatArray<T>)[]): RestorePoint[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RestorePoint>[]

      Additional items to add to the end of array1.

    Returns RestorePoint[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RestorePoint[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, RestorePoint]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RestorePoint]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: RestorePoint, index: number, array: RestorePoint[]): boolean
        • Parameters

          • value: RestorePoint
          • index: number
          • array: RestorePoint[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RestorePoint, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RestorePoint

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RestorePoint[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: RestorePoint

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RestorePoint, index: number, array: RestorePoint[]): boolean
        • Parameters

          • value: RestorePoint
          • index: number
          • array: RestorePoint[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RestorePoint, index: number, array: RestorePoint[]): any
        • Parameters

          • value: RestorePoint
          • index: number
          • array: RestorePoint[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RestorePoint[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RestorePoint | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: RestorePoint

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: RestorePoint, index: number, obj: RestorePoint[]): boolean
        • Parameters

          • this: void
          • value: RestorePoint
          • index: number
          • obj: RestorePoint[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: RestorePoint, index: number, obj: RestorePoint[]): boolean
        • Parameters

          • value: RestorePoint
          • index: number
          • obj: RestorePoint[]

          Returns boolean

    • Optional thisArg: any

    Returns RestorePoint | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: RestorePoint, index: number, obj: RestorePoint[]): boolean
        • Parameters

          • value: RestorePoint
          • index: number
          • obj: RestorePoint[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: RestorePoint, index: number, array: RestorePoint[]): void
        • Parameters

          • value: RestorePoint
          • index: number
          • array: RestorePoint[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RestorePoint, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RestorePoint

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RestorePoint, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RestorePoint

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RestorePoint, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RestorePoint

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: RestorePoint, index: number, array: RestorePoint[]): U
        • Parameters

          • value: RestorePoint
          • index: number
          • array: RestorePoint[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): RestorePoint | undefined
  • Removes the last element from an array and returns it.

    Returns RestorePoint | undefined

push

  • push(...items: RestorePoint[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: RestorePoint[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): RestorePoint
  • reduce(callbackfn: function, initialValue: RestorePoint): RestorePoint
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: RestorePoint, currentValue: RestorePoint, currentIndex: number, array: RestorePoint[]): RestorePoint
        • Parameters

          • previousValue: RestorePoint
          • currentValue: RestorePoint
          • currentIndex: number
          • array: RestorePoint[]

          Returns RestorePoint

    Returns RestorePoint

  • Parameters

    • callbackfn: function
        • (previousValue: RestorePoint, currentValue: RestorePoint, currentIndex: number, array: RestorePoint[]): RestorePoint
        • Parameters

          • previousValue: RestorePoint
          • currentValue: RestorePoint
          • currentIndex: number
          • array: RestorePoint[]

          Returns RestorePoint

    • initialValue: RestorePoint

    Returns RestorePoint

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RestorePoint, currentIndex: number, array: RestorePoint[]): U
        • Parameters

          • previousValue: U
          • currentValue: RestorePoint
          • currentIndex: number
          • array: RestorePoint[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RestorePoint
  • reduceRight(callbackfn: function, initialValue: RestorePoint): RestorePoint
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: RestorePoint, currentValue: RestorePoint, currentIndex: number, array: RestorePoint[]): RestorePoint
        • Parameters

          • previousValue: RestorePoint
          • currentValue: RestorePoint
          • currentIndex: number
          • array: RestorePoint[]

          Returns RestorePoint

    Returns RestorePoint

  • Parameters

    • callbackfn: function
        • (previousValue: RestorePoint, currentValue: RestorePoint, currentIndex: number, array: RestorePoint[]): RestorePoint
        • Parameters

          • previousValue: RestorePoint
          • currentValue: RestorePoint
          • currentIndex: number
          • array: RestorePoint[]

          Returns RestorePoint

    • initialValue: RestorePoint

    Returns RestorePoint

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RestorePoint, currentIndex: number, array: RestorePoint[]): U
        • Parameters

          • previousValue: U
          • currentValue: RestorePoint
          • currentIndex: number
          • array: RestorePoint[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): RestorePoint[]
  • Reverses the elements in an Array.

    Returns RestorePoint[]

shift

  • shift(): RestorePoint | undefined
  • Removes the first element from an array and returns it.

    Returns RestorePoint | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RestorePoint[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RestorePoint[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: RestorePoint, index: number, array: RestorePoint[]): boolean
        • Parameters

          • value: RestorePoint
          • index: number
          • array: RestorePoint[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): RestorePoint[]
  • splice(start: number, deleteCount: number, ...items: RestorePoint[]): RestorePoint[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RestorePoint[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RestorePoint[]

      Elements to insert into the array in place of the deleted elements.

    Returns RestorePoint[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: RestorePoint[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RestorePoint[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<RestorePoint>
  • Returns an iterable of values in the array

    Returns IterableIterator<RestorePoint>

type

type: object

className

className: string = "RestorePointListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RestorePoint"

name

name: "Composite" = "Composite"

Const SensitivityLabel

SensitivityLabel: object

A sensitivity label.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional informationType

informationType: undefined | string

The information type.

Optional informationTypeId

informationTypeId: undefined | string

The information type ID.

Optional labelId

labelId: undefined | string

The label ID.

Optional labelName

labelName: undefined | string

The label name.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SensitivityLabel"

type

type: object

className

className: string = "SensitivityLabel"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

informationType

informationType: object

serializedName

serializedName: string = "properties.informationType"

type

type: object

name

name: "String" = "String"

informationTypeId

informationTypeId: object

serializedName

serializedName: string = "properties.informationTypeId"

type

type: object

name

name: "String" = "String"

labelId

labelId: object

serializedName

serializedName: string = "properties.labelId"

type

type: object

name

name: "String" = "String"

labelName

labelName: object

serializedName

serializedName: string = "properties.labelName"

type

type: object

name

name: "String" = "String"

Const SensitivityLabelListResult

SensitivityLabelListResult: object
interface

A list of sensitivity labels.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SensitivityLabelListResult"

__@iterator

  • __@iterator(): IterableIterator<SensitivityLabel>
  • Iterator

    Returns IterableIterator<SensitivityLabel>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SensitivityLabel>[]): SensitivityLabel[]
  • concat(...items: (T | ConcatArray<T>)[]): SensitivityLabel[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SensitivityLabel>[]

      Additional items to add to the end of array1.

    Returns SensitivityLabel[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SensitivityLabel[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SensitivityLabel]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SensitivityLabel]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SensitivityLabel, index: number, array: SensitivityLabel[]): boolean
        • Parameters

          • value: SensitivityLabel
          • index: number
          • array: SensitivityLabel[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SensitivityLabel, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SensitivityLabel

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SensitivityLabel[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SensitivityLabel

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SensitivityLabel, index: number, array: SensitivityLabel[]): boolean
        • Parameters

          • value: SensitivityLabel
          • index: number
          • array: SensitivityLabel[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SensitivityLabel, index: number, array: SensitivityLabel[]): any
        • Parameters

          • value: SensitivityLabel
          • index: number
          • array: SensitivityLabel[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SensitivityLabel[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SensitivityLabel | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SensitivityLabel

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SensitivityLabel, index: number, obj: SensitivityLabel[]): boolean
        • Parameters

          • this: void
          • value: SensitivityLabel
          • index: number
          • obj: SensitivityLabel[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SensitivityLabel, index: number, obj: SensitivityLabel[]): boolean
        • Parameters

          • value: SensitivityLabel
          • index: number
          • obj: SensitivityLabel[]

          Returns boolean

    • Optional thisArg: any

    Returns SensitivityLabel | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SensitivityLabel, index: number, obj: SensitivityLabel[]): boolean
        • Parameters

          • value: SensitivityLabel
          • index: number
          • obj: SensitivityLabel[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SensitivityLabel, index: number, array: SensitivityLabel[]): void
        • Parameters

          • value: SensitivityLabel
          • index: number
          • array: SensitivityLabel[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SensitivityLabel, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SensitivityLabel

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SensitivityLabel, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SensitivityLabel

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SensitivityLabel, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SensitivityLabel

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SensitivityLabel, index: number, array: SensitivityLabel[]): U
        • Parameters

          • value: SensitivityLabel
          • index: number
          • array: SensitivityLabel[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SensitivityLabel | undefined
  • Removes the last element from an array and returns it.

    Returns SensitivityLabel | undefined

push

  • push(...items: SensitivityLabel[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SensitivityLabel[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SensitivityLabel
  • reduce(callbackfn: function, initialValue: SensitivityLabel): SensitivityLabel
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SensitivityLabel, currentValue: SensitivityLabel, currentIndex: number, array: SensitivityLabel[]): SensitivityLabel
        • Parameters

          • previousValue: SensitivityLabel
          • currentValue: SensitivityLabel
          • currentIndex: number
          • array: SensitivityLabel[]

          Returns SensitivityLabel

    Returns SensitivityLabel

  • Parameters

    • callbackfn: function
        • (previousValue: SensitivityLabel, currentValue: SensitivityLabel, currentIndex: number, array: SensitivityLabel[]): SensitivityLabel
        • Parameters

          • previousValue: SensitivityLabel
          • currentValue: SensitivityLabel
          • currentIndex: number
          • array: SensitivityLabel[]

          Returns SensitivityLabel

    • initialValue: SensitivityLabel

    Returns SensitivityLabel

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SensitivityLabel, currentIndex: number, array: SensitivityLabel[]): U
        • Parameters

          • previousValue: U
          • currentValue: SensitivityLabel
          • currentIndex: number
          • array: SensitivityLabel[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SensitivityLabel
  • reduceRight(callbackfn: function, initialValue: SensitivityLabel): SensitivityLabel
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SensitivityLabel, currentValue: SensitivityLabel, currentIndex: number, array: SensitivityLabel[]): SensitivityLabel
        • Parameters

          • previousValue: SensitivityLabel
          • currentValue: SensitivityLabel
          • currentIndex: number
          • array: SensitivityLabel[]

          Returns SensitivityLabel

    Returns SensitivityLabel

  • Parameters

    • callbackfn: function
        • (previousValue: SensitivityLabel, currentValue: SensitivityLabel, currentIndex: number, array: SensitivityLabel[]): SensitivityLabel
        • Parameters

          • previousValue: SensitivityLabel
          • currentValue: SensitivityLabel
          • currentIndex: number
          • array: SensitivityLabel[]

          Returns SensitivityLabel

    • initialValue: SensitivityLabel

    Returns SensitivityLabel

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SensitivityLabel, currentIndex: number, array: SensitivityLabel[]): U
        • Parameters

          • previousValue: U
          • currentValue: SensitivityLabel
          • currentIndex: number
          • array: SensitivityLabel[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SensitivityLabel[]
  • Reverses the elements in an Array.

    Returns SensitivityLabel[]

shift

  • shift(): SensitivityLabel | undefined
  • Removes the first element from an array and returns it.

    Returns SensitivityLabel | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SensitivityLabel[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SensitivityLabel[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SensitivityLabel, index: number, array: SensitivityLabel[]): boolean
        • Parameters

          • value: SensitivityLabel
          • index: number
          • array: SensitivityLabel[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SensitivityLabel[]
  • splice(start: number, deleteCount: number, ...items: SensitivityLabel[]): SensitivityLabel[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SensitivityLabel[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SensitivityLabel[]

      Elements to insert into the array in place of the deleted elements.

    Returns SensitivityLabel[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SensitivityLabel[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SensitivityLabel[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SensitivityLabel>
  • Returns an iterable of values in the array

    Returns IterableIterator<SensitivityLabel>

type

type: object

className

className: string = "SensitivityLabelListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SensitivityLabel"

name

name: "Composite" = "Composite"

Const Server

Server: object

An Azure SQL Database server.

Optional administratorLogin

administratorLogin: undefined | string

Administrator username for the server. Once created it cannot be changed.

Optional administratorLoginPassword

administratorLoginPassword: undefined | string

The administrator login password (required for server creation).

Optional fullyQualifiedDomainName

fullyQualifiedDomainName: undefined | string

The fully qualified domain name of the server. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

The Azure Active Directory identity of the server.

Optional kind

kind: undefined | string

Kind of sql server. This is metadata used for the Azure portal experience. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Server"

Optional state

state: undefined | string

The state of the server. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

Optional version

version: undefined | string

The version of the server.

type

type: object

className

className: string = "Server"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

administratorLogin

administratorLogin: object

serializedName

serializedName: string = "properties.administratorLogin"

type

type: object

name

name: "String" = "String"

administratorLoginPassword

administratorLoginPassword: object

serializedName

serializedName: string = "properties.administratorLoginPassword"

type

type: object

name

name: "String" = "String"

fullyQualifiedDomainName

fullyQualifiedDomainName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.fullyQualifiedDomainName"

type

type: object

name

name: "String" = "String"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "ResourceIdentity"

name

name: "Composite" = "Composite"

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "properties.version"

type

type: object

name

name: "String" = "String"

Const ServerAdministratorListResult

ServerAdministratorListResult: object
interface

The response to a list Active Directory Administrators request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ServerAdministratorListResult"

__@iterator

  • __@iterator(): IterableIterator<ServerAzureADAdministrator>
  • Iterator

    Returns IterableIterator<ServerAzureADAdministrator>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ServerAzureADAdministrator>[]): ServerAzureADAdministrator[]
  • concat(...items: (T | ConcatArray<T>)[]): ServerAzureADAdministrator[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServerAzureADAdministrator>[]

      Additional items to add to the end of array1.

    Returns ServerAzureADAdministrator[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServerAzureADAdministrator[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ServerAzureADAdministrator]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServerAzureADAdministrator]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ServerAzureADAdministrator, index: number, array: ServerAzureADAdministrator[]): boolean
        • Parameters

          • value: ServerAzureADAdministrator
          • index: number
          • array: ServerAzureADAdministrator[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServerAzureADAdministrator, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServerAzureADAdministrator

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServerAzureADAdministrator[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ServerAzureADAdministrator

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerAzureADAdministrator, index: number, array: ServerAzureADAdministrator[]): boolean
        • Parameters

          • value: ServerAzureADAdministrator
          • index: number
          • array: ServerAzureADAdministrator[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerAzureADAdministrator, index: number, array: ServerAzureADAdministrator[]): any
        • Parameters

          • value: ServerAzureADAdministrator
          • index: number
          • array: ServerAzureADAdministrator[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServerAzureADAdministrator[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServerAzureADAdministrator | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ServerAzureADAdministrator

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ServerAzureADAdministrator, index: number, obj: ServerAzureADAdministrator[]): boolean
        • Parameters

          • this: void
          • value: ServerAzureADAdministrator
          • index: number
          • obj: ServerAzureADAdministrator[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ServerAzureADAdministrator, index: number, obj: ServerAzureADAdministrator[]): boolean
        • Parameters

          • value: ServerAzureADAdministrator
          • index: number
          • obj: ServerAzureADAdministrator[]

          Returns boolean

    • Optional thisArg: any

    Returns ServerAzureADAdministrator | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ServerAzureADAdministrator, index: number, obj: ServerAzureADAdministrator[]): boolean
        • Parameters

          • value: ServerAzureADAdministrator
          • index: number
          • obj: ServerAzureADAdministrator[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ServerAzureADAdministrator, index: number, array: ServerAzureADAdministrator[]): void
        • Parameters

          • value: ServerAzureADAdministrator
          • index: number
          • array: ServerAzureADAdministrator[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServerAzureADAdministrator, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServerAzureADAdministrator

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServerAzureADAdministrator, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServerAzureADAdministrator

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServerAzureADAdministrator, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServerAzureADAdministrator

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ServerAzureADAdministrator, index: number, array: ServerAzureADAdministrator[]): U
        • Parameters

          • value: ServerAzureADAdministrator
          • index: number
          • array: ServerAzureADAdministrator[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ServerAzureADAdministrator | undefined
  • Removes the last element from an array and returns it.

    Returns ServerAzureADAdministrator | undefined

push

  • push(...items: ServerAzureADAdministrator[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ServerAzureADAdministrator[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ServerAzureADAdministrator
  • reduce(callbackfn: function, initialValue: ServerAzureADAdministrator): ServerAzureADAdministrator
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerAzureADAdministrator, currentValue: ServerAzureADAdministrator, currentIndex: number, array: ServerAzureADAdministrator[]): ServerAzureADAdministrator
        • Parameters

          • previousValue: ServerAzureADAdministrator
          • currentValue: ServerAzureADAdministrator
          • currentIndex: number
          • array: ServerAzureADAdministrator[]

          Returns ServerAzureADAdministrator

    Returns ServerAzureADAdministrator

  • Parameters

    • callbackfn: function
        • (previousValue: ServerAzureADAdministrator, currentValue: ServerAzureADAdministrator, currentIndex: number, array: ServerAzureADAdministrator[]): ServerAzureADAdministrator
        • Parameters

          • previousValue: ServerAzureADAdministrator
          • currentValue: ServerAzureADAdministrator
          • currentIndex: number
          • array: ServerAzureADAdministrator[]

          Returns ServerAzureADAdministrator

    • initialValue: ServerAzureADAdministrator

    Returns ServerAzureADAdministrator

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerAzureADAdministrator, currentIndex: number, array: ServerAzureADAdministrator[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerAzureADAdministrator
          • currentIndex: number
          • array: ServerAzureADAdministrator[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ServerAzureADAdministrator
  • reduceRight(callbackfn: function, initialValue: ServerAzureADAdministrator): ServerAzureADAdministrator
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerAzureADAdministrator, currentValue: ServerAzureADAdministrator, currentIndex: number, array: ServerAzureADAdministrator[]): ServerAzureADAdministrator
        • Parameters

          • previousValue: ServerAzureADAdministrator
          • currentValue: ServerAzureADAdministrator
          • currentIndex: number
          • array: ServerAzureADAdministrator[]

          Returns ServerAzureADAdministrator

    Returns ServerAzureADAdministrator

  • Parameters

    • callbackfn: function
        • (previousValue: ServerAzureADAdministrator, currentValue: ServerAzureADAdministrator, currentIndex: number, array: ServerAzureADAdministrator[]): ServerAzureADAdministrator
        • Parameters

          • previousValue: ServerAzureADAdministrator
          • currentValue: ServerAzureADAdministrator
          • currentIndex: number
          • array: ServerAzureADAdministrator[]

          Returns ServerAzureADAdministrator

    • initialValue: ServerAzureADAdministrator

    Returns ServerAzureADAdministrator

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerAzureADAdministrator, currentIndex: number, array: ServerAzureADAdministrator[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerAzureADAdministrator
          • currentIndex: number
          • array: ServerAzureADAdministrator[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ServerAzureADAdministrator[]
  • Reverses the elements in an Array.

    Returns ServerAzureADAdministrator[]

shift

  • shift(): ServerAzureADAdministrator | undefined
  • Removes the first element from an array and returns it.

    Returns ServerAzureADAdministrator | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServerAzureADAdministrator[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServerAzureADAdministrator[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ServerAzureADAdministrator, index: number, array: ServerAzureADAdministrator[]): boolean
        • Parameters

          • value: ServerAzureADAdministrator
          • index: number
          • array: ServerAzureADAdministrator[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ServerAzureADAdministrator[]
  • splice(start: number, deleteCount: number, ...items: ServerAzureADAdministrator[]): ServerAzureADAdministrator[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServerAzureADAdministrator[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServerAzureADAdministrator[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServerAzureADAdministrator[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ServerAzureADAdministrator[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServerAzureADAdministrator[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ServerAzureADAdministrator>
  • Returns an iterable of values in the array

    Returns IterableIterator<ServerAzureADAdministrator>

type

type: object

className

className: string = "ServerAdministratorListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServerAzureADAdministrator"

name

name: "Composite" = "Composite"

Const ServerAutomaticTuning

ServerAutomaticTuning: object

Server-level Automatic Tuning.

Optional actualState

Automatic tuning actual state. Possible values include: 'Custom', 'Auto', 'Unspecified' NOTE: This property will not be serialized. It can only be populated by the server.

Optional desiredState

Automatic tuning desired state. Possible values include: 'Custom', 'Auto', 'Unspecified'

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional options

options: undefined | object

Automatic tuning options definition.

serializedName

serializedName: string = "ServerAutomaticTuning"

type

type: object

className

className: string = "ServerAutomaticTuning"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actualState

actualState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.actualState"

type

type: object

allowedValues

allowedValues: string[] = ["Custom","Auto","Unspecified"]

name

name: "Enum" = "Enum"

desiredState

desiredState: object

serializedName

serializedName: string = "properties.desiredState"

type

type: object

allowedValues

allowedValues: string[] = ["Custom","Auto","Unspecified"]

name

name: "Enum" = "Enum"

options

options: object

serializedName

serializedName: string = "properties.options"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "AutomaticTuningServerOptions"

name

name: "Composite" = "Composite"

Const ServerAzureADAdministrator

ServerAzureADAdministrator: object

An server Active Directory Administrator.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

login

login: string

The server administrator login value.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServerAzureADAdministrator"

sid

sid: string

The server administrator Sid (Secure ID).

tenantId

tenantId: string

The server Active Directory Administrator tenant id.

type

type: object

className

className: string = "ServerAzureADAdministrator"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

administratorType

administratorType: object

defaultValue

defaultValue: string = "ActiveDirectory"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "properties.administratorType"

type

type: object

name

name: "String" = "String"

login

login: object

required

required: true = true

serializedName

serializedName: string = "properties.login"

type

type: object

name

name: "String" = "String"

sid

sid: object

required

required: true = true

serializedName

serializedName: string = "properties.sid"

type

type: object

name

name: "Uuid" = "Uuid"

tenantId

tenantId: object

required

required: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "Uuid" = "Uuid"

Const ServerBlobAuditingPolicy

ServerBlobAuditingPolicy: object

A server blob auditing policy.

Optional auditActionsAndGroups

auditActionsAndGroups: string[]

Specifies the Actions-Groups and Actions to audit.

The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:

BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP.

This above combination is also the set that is configured by default when enabling auditing from the Azure portal.

The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):

APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP

These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.

For more information, see Database-Level Audit Action Groups.

For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES

The general form for defining an action to be audited is: {action} ON {object} BY {principal}

Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.

For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public

For more information, see Database-Level Audit Actions

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isAzureMonitorTargetEnabled

isAzureMonitorTargetEnabled: undefined | false | true

Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.

When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}.

Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview

For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

Optional isStorageSecondaryKeyInUse

isStorageSecondaryKeyInUse: undefined | false | true

Specifies whether storageAccountAccessKey value is the storage's secondary key.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional retentionDays

retentionDays: undefined | number

Specifies the number of days to keep in the audit logs in the storage account.

serializedName

serializedName: string = "ServerBlobAuditingPolicy"

state

Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Possible values include: 'Enabled', 'Disabled'

Optional storageAccountAccessKey

storageAccountAccessKey: undefined | string

Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.

Optional storageAccountSubscriptionId

storageAccountSubscriptionId: undefined | string

Specifies the blob storage subscription Id.

Optional storageEndpoint

storageEndpoint: undefined | string

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.

type

type: object

className

className: string = "ServerBlobAuditingPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

auditActionsAndGroups

auditActionsAndGroups: object

serializedName

serializedName: string = "properties.auditActionsAndGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

isAzureMonitorTargetEnabled

isAzureMonitorTargetEnabled: object

serializedName

serializedName: string = "properties.isAzureMonitorTargetEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

isStorageSecondaryKeyInUse

isStorageSecondaryKeyInUse: object

serializedName

serializedName: string = "properties.isStorageSecondaryKeyInUse"

type

type: object

name

name: "Boolean" = "Boolean"

retentionDays

retentionDays: object

serializedName

serializedName: string = "properties.retentionDays"

type

type: object

name

name: "Number" = "Number"

state

state: object

required

required: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

storageAccountAccessKey

storageAccountAccessKey: object

serializedName

serializedName: string = "properties.storageAccountAccessKey"

type

type: object

name

name: "String" = "String"

storageAccountSubscriptionId

storageAccountSubscriptionId: object

serializedName

serializedName: string = "properties.storageAccountSubscriptionId"

type

type: object

name

name: "Uuid" = "Uuid"

storageEndpoint

storageEndpoint: object

serializedName

serializedName: string = "properties.storageEndpoint"

type

type: object

name

name: "String" = "String"

Const ServerCommunicationLink

ServerCommunicationLink: object

Server communication link.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Communication link kind. This property is used for Azure Portal metadata. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

Communication link location. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

partnerServer

partnerServer: string

The name of the partner server.

serializedName

serializedName: string = "ServerCommunicationLink"

Optional state

state: undefined | string

The state. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ServerCommunicationLink"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

partnerServer

partnerServer: object

required

required: true = true

serializedName

serializedName: string = "properties.partnerServer"

type

type: object

name

name: "String" = "String"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const ServerCommunicationLinkListResult

ServerCommunicationLinkListResult: object
interface

A list of server communication links.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ServerCommunicationLinkListResult"

__@iterator

  • __@iterator(): IterableIterator<ServerCommunicationLink>
  • Iterator

    Returns IterableIterator<ServerCommunicationLink>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ServerCommunicationLink>[]): ServerCommunicationLink[]
  • concat(...items: (T | ConcatArray<T>)[]): ServerCommunicationLink[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServerCommunicationLink>[]

      Additional items to add to the end of array1.

    Returns ServerCommunicationLink[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServerCommunicationLink[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ServerCommunicationLink]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServerCommunicationLink]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ServerCommunicationLink, index: number, array: ServerCommunicationLink[]): boolean
        • Parameters

          • value: ServerCommunicationLink
          • index: number
          • array: ServerCommunicationLink[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServerCommunicationLink, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServerCommunicationLink

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServerCommunicationLink[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ServerCommunicationLink

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerCommunicationLink, index: number, array: ServerCommunicationLink[]): boolean
        • Parameters

          • value: ServerCommunicationLink
          • index: number
          • array: ServerCommunicationLink[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerCommunicationLink, index: number, array: ServerCommunicationLink[]): any
        • Parameters

          • value: ServerCommunicationLink
          • index: number
          • array: ServerCommunicationLink[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServerCommunicationLink[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServerCommunicationLink | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ServerCommunicationLink

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ServerCommunicationLink, index: number, obj: ServerCommunicationLink[]): boolean
        • Parameters

          • this: void
          • value: ServerCommunicationLink
          • index: number
          • obj: ServerCommunicationLink[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ServerCommunicationLink, index: number, obj: ServerCommunicationLink[]): boolean
        • Parameters

          • value: ServerCommunicationLink
          • index: number
          • obj: ServerCommunicationLink[]

          Returns boolean

    • Optional thisArg: any

    Returns ServerCommunicationLink | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ServerCommunicationLink, index: number, obj: ServerCommunicationLink[]): boolean
        • Parameters

          • value: ServerCommunicationLink
          • index: number
          • obj: ServerCommunicationLink[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ServerCommunicationLink, index: number, array: ServerCommunicationLink[]): void
        • Parameters

          • value: ServerCommunicationLink
          • index: number
          • array: ServerCommunicationLink[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServerCommunicationLink, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServerCommunicationLink

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServerCommunicationLink, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServerCommunicationLink

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServerCommunicationLink, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServerCommunicationLink

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ServerCommunicationLink, index: number, array: ServerCommunicationLink[]): U
        • Parameters

          • value: ServerCommunicationLink
          • index: number
          • array: ServerCommunicationLink[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ServerCommunicationLink | undefined
  • Removes the last element from an array and returns it.

    Returns ServerCommunicationLink | undefined

push

  • push(...items: ServerCommunicationLink[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ServerCommunicationLink[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ServerCommunicationLink
  • reduce(callbackfn: function, initialValue: ServerCommunicationLink): ServerCommunicationLink
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerCommunicationLink, currentValue: ServerCommunicationLink, currentIndex: number, array: ServerCommunicationLink[]): ServerCommunicationLink
        • Parameters

          • previousValue: ServerCommunicationLink
          • currentValue: ServerCommunicationLink
          • currentIndex: number
          • array: ServerCommunicationLink[]

          Returns ServerCommunicationLink

    Returns ServerCommunicationLink

  • Parameters

    • callbackfn: function
        • (previousValue: ServerCommunicationLink, currentValue: ServerCommunicationLink, currentIndex: number, array: ServerCommunicationLink[]): ServerCommunicationLink
        • Parameters

          • previousValue: ServerCommunicationLink
          • currentValue: ServerCommunicationLink
          • currentIndex: number
          • array: ServerCommunicationLink[]

          Returns ServerCommunicationLink

    • initialValue: ServerCommunicationLink

    Returns ServerCommunicationLink

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerCommunicationLink, currentIndex: number, array: ServerCommunicationLink[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerCommunicationLink
          • currentIndex: number
          • array: ServerCommunicationLink[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ServerCommunicationLink
  • reduceRight(callbackfn: function, initialValue: ServerCommunicationLink): ServerCommunicationLink
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerCommunicationLink, currentValue: ServerCommunicationLink, currentIndex: number, array: ServerCommunicationLink[]): ServerCommunicationLink
        • Parameters

          • previousValue: ServerCommunicationLink
          • currentValue: ServerCommunicationLink
          • currentIndex: number
          • array: ServerCommunicationLink[]

          Returns ServerCommunicationLink

    Returns ServerCommunicationLink

  • Parameters

    • callbackfn: function
        • (previousValue: ServerCommunicationLink, currentValue: ServerCommunicationLink, currentIndex: number, array: ServerCommunicationLink[]): ServerCommunicationLink
        • Parameters

          • previousValue: ServerCommunicationLink
          • currentValue: ServerCommunicationLink
          • currentIndex: number
          • array: ServerCommunicationLink[]

          Returns ServerCommunicationLink

    • initialValue: ServerCommunicationLink

    Returns ServerCommunicationLink

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerCommunicationLink, currentIndex: number, array: ServerCommunicationLink[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerCommunicationLink
          • currentIndex: number
          • array: ServerCommunicationLink[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ServerCommunicationLink[]
  • Reverses the elements in an Array.

    Returns ServerCommunicationLink[]

shift

  • shift(): ServerCommunicationLink | undefined
  • Removes the first element from an array and returns it.

    Returns ServerCommunicationLink | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServerCommunicationLink[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServerCommunicationLink[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ServerCommunicationLink, index: number, array: ServerCommunicationLink[]): boolean
        • Parameters

          • value: ServerCommunicationLink
          • index: number
          • array: ServerCommunicationLink[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ServerCommunicationLink[]
  • splice(start: number, deleteCount: number, ...items: ServerCommunicationLink[]): ServerCommunicationLink[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServerCommunicationLink[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServerCommunicationLink[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServerCommunicationLink[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ServerCommunicationLink[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServerCommunicationLink[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ServerCommunicationLink>
  • Returns an iterable of values in the array

    Returns IterableIterator<ServerCommunicationLink>

type

type: object

className

className: string = "ServerCommunicationLinkListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServerCommunicationLink"

name

name: "Composite" = "Composite"

Const ServerConnectionPolicy

ServerConnectionPolicy: object

A server secure connection policy.

connectionType

connectionType: ServerConnectionType

The server connection type. Possible values include: 'Default', 'Proxy', 'Redirect'

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Metadata used for the Azure portal experience. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

Resource location. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServerConnectionPolicy"

type

type: object

className

className: string = "ServerConnectionPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionType

connectionType: object

required

required: true = true

serializedName

serializedName: string = "properties.connectionType"

type

type: object

allowedValues

allowedValues: string[] = ["Default","Proxy","Redirect"]

name

name: "Enum" = "Enum"

kind

kind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

Const ServerDnsAlias

ServerDnsAlias: object

A server DNS alias.

Optional azureDnsRecord

azureDnsRecord: undefined | string

The fully qualified DNS record for alias NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServerDnsAlias"

type

type: object

className

className: string = "ServerDnsAlias"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureDnsRecord

azureDnsRecord: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.azureDnsRecord"

type

type: object

name

name: "String" = "String"

Const ServerDnsAliasAcquisition

ServerDnsAliasAcquisition: object

A server DNS alias acquisition request.

Optional oldServerDnsAliasId

oldServerDnsAliasId: undefined | string

The id of the server alias that will be acquired to point to this server instead.

serializedName

serializedName: string = "ServerDnsAliasAcquisition"

type

type: object

className

className: string = "ServerDnsAliasAcquisition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

oldServerDnsAliasId

oldServerDnsAliasId: object

serializedName

serializedName: string = "oldServerDnsAliasId"

type

type: object

name

name: "String" = "String"

Const ServerDnsAliasListResult

ServerDnsAliasListResult: object
interface

A list of server DNS aliases.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServerDnsAliasListResult"

__@iterator

  • __@iterator(): IterableIterator<ServerDnsAlias>
  • Iterator

    Returns IterableIterator<ServerDnsAlias>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ServerDnsAlias>[]): ServerDnsAlias[]
  • concat(...items: (T | ConcatArray<T>)[]): ServerDnsAlias[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServerDnsAlias>[]

      Additional items to add to the end of array1.

    Returns ServerDnsAlias[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServerDnsAlias[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ServerDnsAlias]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServerDnsAlias]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ServerDnsAlias, index: number, array: ServerDnsAlias[]): boolean
        • Parameters

          • value: ServerDnsAlias
          • index: number
          • array: ServerDnsAlias[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServerDnsAlias, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServerDnsAlias

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServerDnsAlias[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ServerDnsAlias

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerDnsAlias, index: number, array: ServerDnsAlias[]): boolean
        • Parameters

          • value: ServerDnsAlias
          • index: number
          • array: ServerDnsAlias[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerDnsAlias, index: number, array: ServerDnsAlias[]): any
        • Parameters

          • value: ServerDnsAlias
          • index: number
          • array: ServerDnsAlias[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServerDnsAlias[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServerDnsAlias | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ServerDnsAlias

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ServerDnsAlias, index: number, obj: ServerDnsAlias[]): boolean
        • Parameters

          • this: void
          • value: ServerDnsAlias
          • index: number
          • obj: ServerDnsAlias[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ServerDnsAlias, index: number, obj: ServerDnsAlias[]): boolean
        • Parameters

          • value: ServerDnsAlias
          • index: number
          • obj: ServerDnsAlias[]

          Returns boolean

    • Optional thisArg: any

    Returns ServerDnsAlias | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ServerDnsAlias, index: number, obj: ServerDnsAlias[]): boolean
        • Parameters

          • value: ServerDnsAlias
          • index: number
          • obj: ServerDnsAlias[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ServerDnsAlias, index: number, array: ServerDnsAlias[]): void
        • Parameters

          • value: ServerDnsAlias
          • index: number
          • array: ServerDnsAlias[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServerDnsAlias, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServerDnsAlias

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServerDnsAlias, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServerDnsAlias

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServerDnsAlias, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServerDnsAlias

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ServerDnsAlias, index: number, array: ServerDnsAlias[]): U
        • Parameters

          • value: ServerDnsAlias
          • index: number
          • array: ServerDnsAlias[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ServerDnsAlias | undefined
  • Removes the last element from an array and returns it.

    Returns ServerDnsAlias | undefined

push

  • push(...items: ServerDnsAlias[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ServerDnsAlias[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ServerDnsAlias
  • reduce(callbackfn: function, initialValue: ServerDnsAlias): ServerDnsAlias
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerDnsAlias, currentValue: ServerDnsAlias, currentIndex: number, array: ServerDnsAlias[]): ServerDnsAlias
        • Parameters

          • previousValue: ServerDnsAlias
          • currentValue: ServerDnsAlias
          • currentIndex: number
          • array: ServerDnsAlias[]

          Returns ServerDnsAlias

    Returns ServerDnsAlias

  • Parameters

    • callbackfn: function
        • (previousValue: ServerDnsAlias, currentValue: ServerDnsAlias, currentIndex: number, array: ServerDnsAlias[]): ServerDnsAlias
        • Parameters

          • previousValue: ServerDnsAlias
          • currentValue: ServerDnsAlias
          • currentIndex: number
          • array: ServerDnsAlias[]

          Returns ServerDnsAlias

    • initialValue: ServerDnsAlias

    Returns ServerDnsAlias

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerDnsAlias, currentIndex: number, array: ServerDnsAlias[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerDnsAlias
          • currentIndex: number
          • array: ServerDnsAlias[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ServerDnsAlias
  • reduceRight(callbackfn: function, initialValue: ServerDnsAlias): ServerDnsAlias
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerDnsAlias, currentValue: ServerDnsAlias, currentIndex: number, array: ServerDnsAlias[]): ServerDnsAlias
        • Parameters

          • previousValue: ServerDnsAlias
          • currentValue: ServerDnsAlias
          • currentIndex: number
          • array: ServerDnsAlias[]

          Returns ServerDnsAlias

    Returns ServerDnsAlias

  • Parameters

    • callbackfn: function
        • (previousValue: ServerDnsAlias, currentValue: ServerDnsAlias, currentIndex: number, array: ServerDnsAlias[]): ServerDnsAlias
        • Parameters

          • previousValue: ServerDnsAlias
          • currentValue: ServerDnsAlias
          • currentIndex: number
          • array: ServerDnsAlias[]

          Returns ServerDnsAlias

    • initialValue: ServerDnsAlias

    Returns ServerDnsAlias

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerDnsAlias, currentIndex: number, array: ServerDnsAlias[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerDnsAlias
          • currentIndex: number
          • array: ServerDnsAlias[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ServerDnsAlias[]
  • Reverses the elements in an Array.

    Returns ServerDnsAlias[]

shift

  • shift(): ServerDnsAlias | undefined
  • Removes the first element from an array and returns it.

    Returns ServerDnsAlias | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServerDnsAlias[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServerDnsAlias[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ServerDnsAlias, index: number, array: ServerDnsAlias[]): boolean
        • Parameters

          • value: ServerDnsAlias
          • index: number
          • array: ServerDnsAlias[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ServerDnsAlias[]
  • splice(start: number, deleteCount: number, ...items: ServerDnsAlias[]): ServerDnsAlias[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServerDnsAlias[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServerDnsAlias[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServerDnsAlias[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ServerDnsAlias[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServerDnsAlias[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ServerDnsAlias>
  • Returns an iterable of values in the array

    Returns IterableIterator<ServerDnsAlias>

type

type: object

className

className: string = "ServerDnsAliasListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServerDnsAlias"

name

name: "Composite" = "Composite"

Const ServerKey

ServerKey: object

A server key.

Optional creationDate

creationDate: Date

The server key creation date.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of encryption protector. This is metadata used for the Azure portal experience.

Optional location

location: undefined | string

Resource location. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServerKey"

serverKeyType

serverKeyType: ServerKeyType

The server key type like 'ServiceManaged', 'AzureKeyVault'. Possible values include: 'ServiceManaged', 'AzureKeyVault'

Optional subregion

subregion: undefined | string

Subregion of the server key. NOTE: This property will not be serialized. It can only be populated by the server.

Optional thumbprint

thumbprint: undefined | string

Thumbprint of the server key.

Optional uri

uri: undefined | string

The URI of the server key.

type

type: object

className

className: string = "ServerKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationDate

creationDate: object

serializedName

serializedName: string = "properties.creationDate"

type

type: object

name

name: "DateTime" = "DateTime"

kind

kind: object

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

serverKeyType

serverKeyType: object

required

required: true = true

serializedName

serializedName: string = "properties.serverKeyType"

type

type: object

name

name: "String" = "String"

subregion

subregion: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subregion"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

uri

uri: object

serializedName

serializedName: string = "properties.uri"

type

type: object

name

name: "String" = "String"

Const ServerKeyListResult

ServerKeyListResult: object
interface

A list of server keys.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServerKeyListResult"

__@iterator

  • __@iterator(): IterableIterator<ServerKey>
  • Iterator

    Returns IterableIterator<ServerKey>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ServerKey>[]): ServerKey[]
  • concat(...items: (T | ConcatArray<T>)[]): ServerKey[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServerKey>[]

      Additional items to add to the end of array1.

    Returns ServerKey[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServerKey[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ServerKey]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServerKey]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ServerKey, index: number, array: ServerKey[]): boolean
        • Parameters

          • value: ServerKey
          • index: number
          • array: ServerKey[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServerKey, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServerKey

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServerKey[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ServerKey

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerKey, index: number, array: ServerKey[]): boolean
        • Parameters

          • value: ServerKey
          • index: number
          • array: ServerKey[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerKey, index: number, array: ServerKey[]): any
        • Parameters

          • value: ServerKey
          • index: number
          • array: ServerKey[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServerKey[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServerKey | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ServerKey

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ServerKey, index: number, obj: ServerKey[]): boolean
        • Parameters

          • this: void
          • value: ServerKey
          • index: number
          • obj: ServerKey[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ServerKey, index: number, obj: ServerKey[]): boolean
        • Parameters

          • value: ServerKey
          • index: number
          • obj: ServerKey[]

          Returns boolean

    • Optional thisArg: any

    Returns ServerKey | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ServerKey, index: number, obj: ServerKey[]): boolean
        • Parameters

          • value: ServerKey
          • index: number
          • obj: ServerKey[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ServerKey, index: number, array: ServerKey[]): void
        • Parameters

          • value: ServerKey
          • index: number
          • array: ServerKey[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServerKey, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServerKey

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServerKey, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServerKey

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServerKey, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServerKey

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ServerKey, index: number, array: ServerKey[]): U
        • Parameters

          • value: ServerKey
          • index: number
          • array: ServerKey[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ServerKey | undefined
  • Removes the last element from an array and returns it.

    Returns ServerKey | undefined

push

  • push(...items: ServerKey[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ServerKey[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ServerKey
  • reduce(callbackfn: function, initialValue: ServerKey): ServerKey
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerKey, currentValue: ServerKey, currentIndex: number, array: ServerKey[]): ServerKey
        • Parameters

          • previousValue: ServerKey
          • currentValue: ServerKey
          • currentIndex: number
          • array: ServerKey[]

          Returns ServerKey

    Returns ServerKey

  • Parameters

    • callbackfn: function
        • (previousValue: ServerKey, currentValue: ServerKey, currentIndex: number, array: ServerKey[]): ServerKey
        • Parameters

          • previousValue: ServerKey
          • currentValue: ServerKey
          • currentIndex: number
          • array: ServerKey[]

          Returns ServerKey

    • initialValue: ServerKey

    Returns ServerKey

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerKey, currentIndex: number, array: ServerKey[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerKey
          • currentIndex: number
          • array: ServerKey[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ServerKey
  • reduceRight(callbackfn: function, initialValue: ServerKey): ServerKey
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerKey, currentValue: ServerKey, currentIndex: number, array: ServerKey[]): ServerKey
        • Parameters

          • previousValue: ServerKey
          • currentValue: ServerKey
          • currentIndex: number
          • array: ServerKey[]

          Returns ServerKey

    Returns ServerKey

  • Parameters

    • callbackfn: function
        • (previousValue: ServerKey, currentValue: ServerKey, currentIndex: number, array: ServerKey[]): ServerKey
        • Parameters

          • previousValue: ServerKey
          • currentValue: ServerKey
          • currentIndex: number
          • array: ServerKey[]

          Returns ServerKey

    • initialValue: ServerKey

    Returns ServerKey

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerKey, currentIndex: number, array: ServerKey[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerKey
          • currentIndex: number
          • array: ServerKey[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ServerKey[]
  • Reverses the elements in an Array.

    Returns ServerKey[]

shift

  • shift(): ServerKey | undefined
  • Removes the first element from an array and returns it.

    Returns ServerKey | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServerKey[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServerKey[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ServerKey, index: number, array: ServerKey[]): boolean
        • Parameters

          • value: ServerKey
          • index: number
          • array: ServerKey[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ServerKey[]
  • splice(start: number, deleteCount: number, ...items: ServerKey[]): ServerKey[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServerKey[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServerKey[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServerKey[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ServerKey[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServerKey[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ServerKey>
  • Returns an iterable of values in the array

    Returns IterableIterator<ServerKey>

type

type: object

className

className: string = "ServerKeyListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServerKey"

name

name: "Composite" = "Composite"

Const ServerListResult

ServerListResult: object
interface

A list of servers.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServerListResult"

__@iterator

  • __@iterator(): IterableIterator<Server>
  • Iterator

    Returns IterableIterator<Server>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Server>[]): Server[]
  • concat(...items: (T | ConcatArray<T>)[]): Server[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Server>[]

      Additional items to add to the end of array1.

    Returns Server[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Server[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Server]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Server]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Server, index: number, array: Server[]): boolean
        • Parameters

          • value: Server
          • index: number
          • array: Server[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Server, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Server

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Server[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Server

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Server, index: number, array: Server[]): boolean
        • Parameters

          • value: Server
          • index: number
          • array: Server[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Server, index: number, array: Server[]): any
        • Parameters

          • value: Server
          • index: number
          • array: Server[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Server[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Server | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Server

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Server, index: number, obj: Server[]): boolean
        • Parameters

          • this: void
          • value: Server
          • index: number
          • obj: Server[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Server, index: number, obj: Server[]): boolean
        • Parameters

          • value: Server
          • index: number
          • obj: Server[]

          Returns boolean

    • Optional thisArg: any

    Returns Server | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Server, index: number, obj: Server[]): boolean
        • Parameters

          • value: Server
          • index: number
          • obj: Server[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Server, index: number, array: Server[]): void
        • Parameters

          • value: Server
          • index: number
          • array: Server[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Server, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Server

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Server, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Server

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Server, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Server

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Server, index: number, array: Server[]): U
        • Parameters

          • value: Server
          • index: number
          • array: Server[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Server | undefined
  • Removes the last element from an array and returns it.

    Returns Server | undefined

push

  • push(...items: Server[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Server[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Server
  • reduce(callbackfn: function, initialValue: Server): Server
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Server, currentValue: Server, currentIndex: number, array: Server[]): Server
        • Parameters

          • previousValue: Server
          • currentValue: Server
          • currentIndex: number
          • array: Server[]

          Returns Server

    Returns Server

  • Parameters

    • callbackfn: function
        • (previousValue: Server, currentValue: Server, currentIndex: number, array: Server[]): Server
        • Parameters

          • previousValue: Server
          • currentValue: Server
          • currentIndex: number
          • array: Server[]

          Returns Server

    • initialValue: Server

    Returns Server

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Server, currentIndex: number, array: Server[]): U
        • Parameters

          • previousValue: U
          • currentValue: Server
          • currentIndex: number
          • array: Server[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Server
  • reduceRight(callbackfn: function, initialValue: Server): Server
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Server, currentValue: Server, currentIndex: number, array: Server[]): Server
        • Parameters

          • previousValue: Server
          • currentValue: Server
          • currentIndex: number
          • array: Server[]

          Returns Server

    Returns Server

  • Parameters

    • callbackfn: function
        • (previousValue: Server, currentValue: Server, currentIndex: number, array: Server[]): Server
        • Parameters

          • previousValue: Server
          • currentValue: Server
          • currentIndex: number
          • array: Server[]

          Returns Server

    • initialValue: Server

    Returns Server

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Server, currentIndex: number, array: Server[]): U
        • Parameters

          • previousValue: U
          • currentValue: Server
          • currentIndex: number
          • array: Server[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Server[]
  • Reverses the elements in an Array.

    Returns Server[]

shift

  • shift(): Server | undefined
  • Removes the first element from an array and returns it.

    Returns Server | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Server[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Server[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Server, index: number, array: Server[]): boolean
        • Parameters

          • value: Server
          • index: number
          • array: Server[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Server[]
  • splice(start: number, deleteCount: number, ...items: Server[]): Server[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Server[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Server[]

      Elements to insert into the array in place of the deleted elements.

    Returns Server[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Server[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Server[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Server>
  • Returns an iterable of values in the array

    Returns IterableIterator<Server>

type

type: object

className

className: string = "ServerListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Server"

name

name: "Composite" = "Composite"

Const ServerSecurityAlertPolicy

ServerSecurityAlertPolicy: object

A server security alert policy.

Optional creationTime

creationTime: Date

Specifies the UTC creation time of the policy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional disabledAlerts

disabledAlerts: string[]

Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action

Optional emailAccountAdmins

emailAccountAdmins: undefined | false | true

Specifies that the alert is sent to the account administrators.

Optional emailAddresses

emailAddresses: string[]

Specifies an array of e-mail addresses to which the alert is sent.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional retentionDays

retentionDays: undefined | number

Specifies the number of days to keep in the Threat Detection audit logs.

serializedName

serializedName: string = "ServerSecurityAlertPolicy"

state

Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. Possible values include: 'New', 'Enabled', 'Disabled'

Optional storageAccountAccessKey

storageAccountAccessKey: undefined | string

Specifies the identifier key of the Threat Detection audit storage account.

Optional storageEndpoint

storageEndpoint: undefined | string

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

type

type: object

className

className: string = "ServerSecurityAlertPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

disabledAlerts

disabledAlerts: object

serializedName

serializedName: string = "properties.disabledAlerts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

emailAccountAdmins

emailAccountAdmins: object

serializedName

serializedName: string = "properties.emailAccountAdmins"

type

type: object

name

name: "Boolean" = "Boolean"

emailAddresses

emailAddresses: object

serializedName

serializedName: string = "properties.emailAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

retentionDays

retentionDays: object

serializedName

serializedName: string = "properties.retentionDays"

type

type: object

name

name: "Number" = "Number"

state

state: object

required

required: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["New","Enabled","Disabled"]

name

name: "Enum" = "Enum"

storageAccountAccessKey

storageAccountAccessKey: object

serializedName

serializedName: string = "properties.storageAccountAccessKey"

type

type: object

name

name: "String" = "String"

storageEndpoint

storageEndpoint: object

serializedName

serializedName: string = "properties.storageEndpoint"

type

type: object

name

name: "String" = "String"

Const ServerUpdate

ServerUpdate: object

An update request for an Azure SQL Database server.

Optional administratorLogin

administratorLogin: undefined | string

Administrator username for the server. Once created it cannot be changed.

Optional administratorLoginPassword

administratorLoginPassword: undefined | string

The administrator login password (required for server creation).

Optional fullyQualifiedDomainName

fullyQualifiedDomainName: undefined | string

The fully qualified domain name of the server. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServerUpdate"

Optional state

state: undefined | string

The state of the server. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

Optional version

version: undefined | string

The version of the server.

type

type: object

className

className: string = "ServerUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

administratorLogin

administratorLogin: object

serializedName

serializedName: string = "properties.administratorLogin"

type

type: object

name

name: "String" = "String"

administratorLoginPassword

administratorLoginPassword: object

serializedName

serializedName: string = "properties.administratorLoginPassword"

type

type: object

name

name: "String" = "String"

fullyQualifiedDomainName

fullyQualifiedDomainName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.fullyQualifiedDomainName"

type

type: object

name

name: "String" = "String"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "properties.version"

type

type: object

name

name: "String" = "String"

Const ServerUsage

ServerUsage: object

Represents server metrics.

Optional currentValue

currentValue: undefined | number

The current value of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional displayName

displayName: undefined | string

The metric display name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional limit

limit: undefined | number

The current limit of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Name of the server usage metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextResetTime

nextResetTime: Date

The next reset time for the metric (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceName

resourceName: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServerUsage"

Optional unit

unit: undefined | string

The units of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ServerUsage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentValue

currentValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "currentValue"

type

type: object

name

name: "Number" = "Number"

displayName

displayName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

limit

limit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "limit"

type

type: object

name

name: "Number" = "Number"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

nextResetTime

nextResetTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextResetTime"

type

type: object

name

name: "DateTime" = "DateTime"

resourceName

resourceName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resourceName"

type

type: object

name

name: "String" = "String"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const ServerUsageListResult

ServerUsageListResult: object
interface

Represents the response to a list server metrics request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ServerUsageListResult"

__@iterator

  • __@iterator(): IterableIterator<ServerUsage>
  • Iterator

    Returns IterableIterator<ServerUsage>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ServerUsage>[]): ServerUsage[]
  • concat(...items: (T | ConcatArray<T>)[]): ServerUsage[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServerUsage>[]

      Additional items to add to the end of array1.

    Returns ServerUsage[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServerUsage[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ServerUsage]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServerUsage]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ServerUsage, index: number, array: ServerUsage[]): boolean
        • Parameters

          • value: ServerUsage
          • index: number
          • array: ServerUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServerUsage, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServerUsage

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServerUsage[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ServerUsage

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerUsage, index: number, array: ServerUsage[]): boolean
        • Parameters

          • value: ServerUsage
          • index: number
          • array: ServerUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerUsage, index: number, array: ServerUsage[]): any
        • Parameters

          • value: ServerUsage
          • index: number
          • array: ServerUsage[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServerUsage[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServerUsage | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ServerUsage

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ServerUsage, index: number, obj: ServerUsage[]): boolean
        • Parameters

          • this: void
          • value: ServerUsage
          • index: number
          • obj: ServerUsage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ServerUsage, index: number, obj: ServerUsage[]): boolean
        • Parameters

          • value: ServerUsage
          • index: number
          • obj: ServerUsage[]

          Returns boolean

    • Optional thisArg: any

    Returns ServerUsage | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ServerUsage, index: number, obj: ServerUsage[]): boolean
        • Parameters

          • value: ServerUsage
          • index: number
          • obj: ServerUsage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ServerUsage, index: number, array: ServerUsage[]): void
        • Parameters

          • value: ServerUsage
          • index: number
          • array: ServerUsage[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServerUsage, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServerUsage

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServerUsage, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServerUsage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServerUsage, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServerUsage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ServerUsage, index: number, array: ServerUsage[]): U
        • Parameters

          • value: ServerUsage
          • index: number
          • array: ServerUsage[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ServerUsage | undefined
  • Removes the last element from an array and returns it.

    Returns ServerUsage | undefined

push

  • push(...items: ServerUsage[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ServerUsage[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ServerUsage
  • reduce(callbackfn: function, initialValue: ServerUsage): ServerUsage
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerUsage, currentValue: ServerUsage, currentIndex: number, array: ServerUsage[]): ServerUsage
        • Parameters

          • previousValue: ServerUsage
          • currentValue: ServerUsage
          • currentIndex: number
          • array: ServerUsage[]

          Returns ServerUsage

    Returns ServerUsage

  • Parameters

    • callbackfn: function
        • (previousValue: ServerUsage, currentValue: ServerUsage, currentIndex: number, array: ServerUsage[]): ServerUsage
        • Parameters

          • previousValue: ServerUsage
          • currentValue: ServerUsage
          • currentIndex: number
          • array: ServerUsage[]

          Returns ServerUsage

    • initialValue: ServerUsage

    Returns ServerUsage

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerUsage, currentIndex: number, array: ServerUsage[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerUsage
          • currentIndex: number
          • array: ServerUsage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ServerUsage
  • reduceRight(callbackfn: function, initialValue: ServerUsage): ServerUsage
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerUsage, currentValue: ServerUsage, currentIndex: number, array: ServerUsage[]): ServerUsage
        • Parameters

          • previousValue: ServerUsage
          • currentValue: ServerUsage
          • currentIndex: number
          • array: ServerUsage[]

          Returns ServerUsage

    Returns ServerUsage

  • Parameters

    • callbackfn: function
        • (previousValue: ServerUsage, currentValue: ServerUsage, currentIndex: number, array: ServerUsage[]): ServerUsage
        • Parameters

          • previousValue: ServerUsage
          • currentValue: ServerUsage
          • currentIndex: number
          • array: ServerUsage[]

          Returns ServerUsage

    • initialValue: ServerUsage

    Returns ServerUsage

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerUsage, currentIndex: number, array: ServerUsage[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerUsage
          • currentIndex: number
          • array: ServerUsage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ServerUsage[]
  • Reverses the elements in an Array.

    Returns ServerUsage[]

shift

  • shift(): ServerUsage | undefined
  • Removes the first element from an array and returns it.

    Returns ServerUsage | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServerUsage[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServerUsage[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ServerUsage, index: number, array: ServerUsage[]): boolean
        • Parameters

          • value: ServerUsage
          • index: number
          • array: ServerUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ServerUsage[]
  • splice(start: number, deleteCount: number, ...items: ServerUsage[]): ServerUsage[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServerUsage[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServerUsage[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServerUsage[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ServerUsage[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServerUsage[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ServerUsage>
  • Returns an iterable of values in the array

    Returns IterableIterator<ServerUsage>

type

type: object

className

className: string = "ServerUsageListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServerUsage"

name

name: "Composite" = "Composite"

Const ServerVersionCapability

ServerVersionCapability: object

The server capability

Optional name

name: undefined | string

The server version name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "ServerVersionCapability"

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedEditions

supportedEditions: EditionCapability[]

The list of supported database editions. NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedElasticPoolEditions

supportedElasticPoolEditions: ElasticPoolEditionCapability[]

The list of supported elastic pool editions. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ServerVersionCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

supportedEditions

supportedEditions: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedEditions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EditionCapability"

name

name: "Composite" = "Composite"

supportedElasticPoolEditions

supportedElasticPoolEditions: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedElasticPoolEditions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ElasticPoolEditionCapability"

name

name: "Composite" = "Composite"

Const ServerVulnerabilityAssessment

ServerVulnerabilityAssessment: object

A server vulnerability assessment.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional recurringScans

The recurring scans settings

serializedName

serializedName: string = "ServerVulnerabilityAssessment"

Optional storageAccountAccessKey

storageAccountAccessKey: undefined | string

Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.

storageContainerPath

storageContainerPath: string

A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).

Optional storageContainerSasKey

storageContainerSasKey: undefined | string

A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.

type

type: object

className

className: string = "ServerVulnerabilityAssessment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

recurringScans

recurringScans: object

serializedName

serializedName: string = "properties.recurringScans"

type

type: object

className

className: string = "VulnerabilityAssessmentRecurringScansProperties"

name

name: "Composite" = "Composite"

storageAccountAccessKey

storageAccountAccessKey: object

serializedName

serializedName: string = "properties.storageAccountAccessKey"

type

type: object

name

name: "String" = "String"

storageContainerPath

storageContainerPath: object

required

required: true = true

serializedName

serializedName: string = "properties.storageContainerPath"

type

type: object

name

name: "String" = "String"

storageContainerSasKey

storageContainerSasKey: object

serializedName

serializedName: string = "properties.storageContainerSasKey"

type

type: object

name

name: "String" = "String"

Const ServerVulnerabilityAssessmentListResult

ServerVulnerabilityAssessmentListResult: object
interface

A list of the server's vulnerability assessments.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServerVulnerabilityAssessmentListResult"

__@iterator

  • __@iterator(): IterableIterator<ServerVulnerabilityAssessment>
  • Iterator

    Returns IterableIterator<ServerVulnerabilityAssessment>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ServerVulnerabilityAssessment>[]): ServerVulnerabilityAssessment[]
  • concat(...items: (T | ConcatArray<T>)[]): ServerVulnerabilityAssessment[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServerVulnerabilityAssessment>[]

      Additional items to add to the end of array1.

    Returns ServerVulnerabilityAssessment[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServerVulnerabilityAssessment[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ServerVulnerabilityAssessment]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServerVulnerabilityAssessment]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ServerVulnerabilityAssessment, index: number, array: ServerVulnerabilityAssessment[]): boolean
        • Parameters

          • value: ServerVulnerabilityAssessment
          • index: number
          • array: ServerVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServerVulnerabilityAssessment, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServerVulnerabilityAssessment

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServerVulnerabilityAssessment[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ServerVulnerabilityAssessment

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerVulnerabilityAssessment, index: number, array: ServerVulnerabilityAssessment[]): boolean
        • Parameters

          • value: ServerVulnerabilityAssessment
          • index: number
          • array: ServerVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServerVulnerabilityAssessment, index: number, array: ServerVulnerabilityAssessment[]): any
        • Parameters

          • value: ServerVulnerabilityAssessment
          • index: number
          • array: ServerVulnerabilityAssessment[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServerVulnerabilityAssessment[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServerVulnerabilityAssessment | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ServerVulnerabilityAssessment

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ServerVulnerabilityAssessment, index: number, obj: ServerVulnerabilityAssessment[]): boolean
        • Parameters

          • this: void
          • value: ServerVulnerabilityAssessment
          • index: number
          • obj: ServerVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ServerVulnerabilityAssessment, index: number, obj: ServerVulnerabilityAssessment[]): boolean
        • Parameters

          • value: ServerVulnerabilityAssessment
          • index: number
          • obj: ServerVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

    Returns ServerVulnerabilityAssessment | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ServerVulnerabilityAssessment, index: number, obj: ServerVulnerabilityAssessment[]): boolean
        • Parameters

          • value: ServerVulnerabilityAssessment
          • index: number
          • obj: ServerVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ServerVulnerabilityAssessment, index: number, array: ServerVulnerabilityAssessment[]): void
        • Parameters

          • value: ServerVulnerabilityAssessment
          • index: number
          • array: ServerVulnerabilityAssessment[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServerVulnerabilityAssessment, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServerVulnerabilityAssessment

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServerVulnerabilityAssessment, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServerVulnerabilityAssessment

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServerVulnerabilityAssessment, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServerVulnerabilityAssessment

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ServerVulnerabilityAssessment, index: number, array: ServerVulnerabilityAssessment[]): U
        • Parameters

          • value: ServerVulnerabilityAssessment
          • index: number
          • array: ServerVulnerabilityAssessment[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ServerVulnerabilityAssessment | undefined
  • Removes the last element from an array and returns it.

    Returns ServerVulnerabilityAssessment | undefined

push

  • push(...items: ServerVulnerabilityAssessment[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ServerVulnerabilityAssessment[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ServerVulnerabilityAssessment
  • reduce(callbackfn: function, initialValue: ServerVulnerabilityAssessment): ServerVulnerabilityAssessment
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerVulnerabilityAssessment, currentValue: ServerVulnerabilityAssessment, currentIndex: number, array: ServerVulnerabilityAssessment[]): ServerVulnerabilityAssessment
        • Parameters

          • previousValue: ServerVulnerabilityAssessment
          • currentValue: ServerVulnerabilityAssessment
          • currentIndex: number
          • array: ServerVulnerabilityAssessment[]

          Returns ServerVulnerabilityAssessment

    Returns ServerVulnerabilityAssessment

  • Parameters

    • callbackfn: function
        • (previousValue: ServerVulnerabilityAssessment, currentValue: ServerVulnerabilityAssessment, currentIndex: number, array: ServerVulnerabilityAssessment[]): ServerVulnerabilityAssessment
        • Parameters

          • previousValue: ServerVulnerabilityAssessment
          • currentValue: ServerVulnerabilityAssessment
          • currentIndex: number
          • array: ServerVulnerabilityAssessment[]

          Returns ServerVulnerabilityAssessment

    • initialValue: ServerVulnerabilityAssessment

    Returns ServerVulnerabilityAssessment

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerVulnerabilityAssessment, currentIndex: number, array: ServerVulnerabilityAssessment[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerVulnerabilityAssessment
          • currentIndex: number
          • array: ServerVulnerabilityAssessment[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ServerVulnerabilityAssessment
  • reduceRight(callbackfn: function, initialValue: ServerVulnerabilityAssessment): ServerVulnerabilityAssessment
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServerVulnerabilityAssessment, currentValue: ServerVulnerabilityAssessment, currentIndex: number, array: ServerVulnerabilityAssessment[]): ServerVulnerabilityAssessment
        • Parameters

          • previousValue: ServerVulnerabilityAssessment
          • currentValue: ServerVulnerabilityAssessment
          • currentIndex: number
          • array: ServerVulnerabilityAssessment[]

          Returns ServerVulnerabilityAssessment

    Returns ServerVulnerabilityAssessment

  • Parameters

    • callbackfn: function
        • (previousValue: ServerVulnerabilityAssessment, currentValue: ServerVulnerabilityAssessment, currentIndex: number, array: ServerVulnerabilityAssessment[]): ServerVulnerabilityAssessment
        • Parameters

          • previousValue: ServerVulnerabilityAssessment
          • currentValue: ServerVulnerabilityAssessment
          • currentIndex: number
          • array: ServerVulnerabilityAssessment[]

          Returns ServerVulnerabilityAssessment

    • initialValue: ServerVulnerabilityAssessment

    Returns ServerVulnerabilityAssessment

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServerVulnerabilityAssessment, currentIndex: number, array: ServerVulnerabilityAssessment[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServerVulnerabilityAssessment
          • currentIndex: number
          • array: ServerVulnerabilityAssessment[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ServerVulnerabilityAssessment[]
  • Reverses the elements in an Array.

    Returns ServerVulnerabilityAssessment[]

shift

  • shift(): ServerVulnerabilityAssessment | undefined
  • Removes the first element from an array and returns it.

    Returns ServerVulnerabilityAssessment | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServerVulnerabilityAssessment[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServerVulnerabilityAssessment[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ServerVulnerabilityAssessment, index: number, array: ServerVulnerabilityAssessment[]): boolean
        • Parameters

          • value: ServerVulnerabilityAssessment
          • index: number
          • array: ServerVulnerabilityAssessment[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ServerVulnerabilityAssessment[]
  • splice(start: number, deleteCount: number, ...items: ServerVulnerabilityAssessment[]): ServerVulnerabilityAssessment[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServerVulnerabilityAssessment[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServerVulnerabilityAssessment[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServerVulnerabilityAssessment[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ServerVulnerabilityAssessment[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServerVulnerabilityAssessment[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ServerVulnerabilityAssessment>
  • Returns an iterable of values in the array

    Returns IterableIterator<ServerVulnerabilityAssessment>

type

type: object

className

className: string = "ServerVulnerabilityAssessmentListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServerVulnerabilityAssessment"

name

name: "Composite" = "Composite"

Const ServiceObjective

ServiceObjective: object

Represents a database service objective.

Optional description

description: undefined | string

The description for the service level objective. NOTE: This property will not be serialized. It can only be populated by the server.

Optional enabled

enabled: undefined | false | true

Gets whether the service level objective is enabled. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isDefault

isDefault: undefined | false | true

Gets whether the service level objective is the default service objective. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isSystem

isSystem: undefined | false | true

Gets whether the service level objective is a system service objective. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceObjective"

Optional serviceObjectiveName

serviceObjectiveName: undefined | string

The name for the service objective. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ServiceObjective"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

isDefault

isDefault: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isDefault"

type

type: object

name

name: "Boolean" = "Boolean"

isSystem

isSystem: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isSystem"

type

type: object

name

name: "Boolean" = "Boolean"

serviceObjectiveName

serviceObjectiveName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serviceObjectiveName"

type

type: object

name

name: "String" = "String"

Const ServiceObjectiveCapability

ServiceObjectiveCapability: object

The service objectives capability.

Optional id

id: undefined | string

The unique ID of the service objective. NOTE: This property will not be serialized. It can only be populated by the server.

Optional includedMaxSize

includedMaxSize: MaxSizeCapability

The included (free) max size. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The service objective name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional performanceLevel

performanceLevel: PerformanceLevelCapability

The performance level. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: undefined | string

The reason for the capability not being available.

serializedName

serializedName: string = "ServiceObjectiveCapability"

Optional sku

sku: Sku

The sku. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

The status of the capability. Possible values include: 'Visible', 'Available', 'Default', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedLicenseTypes

supportedLicenseTypes: LicenseTypeCapability[]

List of supported license types. NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportedMaxSizes

supportedMaxSizes: MaxSizeRangeCapability[]

The list of supported maximum database sizes. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ServiceObjectiveCapability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "Uuid" = "Uuid"

includedMaxSize

includedMaxSize: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "includedMaxSize"

type

type: object

className

className: string = "MaxSizeCapability"

name

name: "Composite" = "Composite"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

performanceLevel

performanceLevel: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "performanceLevel"

type

type: object

className

className: string = "PerformanceLevelCapability"

name

name: "Composite" = "Composite"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

sku

sku: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Visible","Available","Default","Disabled"]

name

name: "Enum" = "Enum"

supportedLicenseTypes

supportedLicenseTypes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedLicenseTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LicenseTypeCapability"

name

name: "Composite" = "Composite"

supportedMaxSizes

supportedMaxSizes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "supportedMaxSizes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MaxSizeRangeCapability"

name

name: "Composite" = "Composite"

Const ServiceObjectiveListResult

ServiceObjectiveListResult: object
interface

Represents the response to a get database service objectives request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ServiceObjectiveListResult"

__@iterator

  • __@iterator(): IterableIterator<ServiceObjective>
  • Iterator

    Returns IterableIterator<ServiceObjective>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ServiceObjective>[]): ServiceObjective[]
  • concat(...items: (T | ConcatArray<T>)[]): ServiceObjective[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServiceObjective>[]

      Additional items to add to the end of array1.

    Returns ServiceObjective[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServiceObjective[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ServiceObjective]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServiceObjective]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ServiceObjective, index: number, array: ServiceObjective[]): boolean
        • Parameters

          • value: ServiceObjective
          • index: number
          • array: ServiceObjective[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServiceObjective, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServiceObjective

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServiceObjective[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ServiceObjective

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServiceObjective, index: number, array: ServiceObjective[]): boolean
        • Parameters

          • value: ServiceObjective
          • index: number
          • array: ServiceObjective[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServiceObjective, index: number, array: ServiceObjective[]): any
        • Parameters

          • value: ServiceObjective
          • index: number
          • array: ServiceObjective[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServiceObjective[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServiceObjective | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ServiceObjective

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ServiceObjective, index: number, obj: ServiceObjective[]): boolean
        • Parameters

          • this: void
          • value: ServiceObjective
          • index: number
          • obj: ServiceObjective[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ServiceObjective, index: number, obj: ServiceObjective[]): boolean
        • Parameters

          • value: ServiceObjective
          • index: number
          • obj: ServiceObjective[]

          Returns boolean

    • Optional thisArg: any

    Returns ServiceObjective | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ServiceObjective, index: number, obj: ServiceObjective[]): boolean
        • Parameters

          • value: ServiceObjective
          • index: number
          • obj: ServiceObjective[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ServiceObjective, index: number, array: ServiceObjective[]): void
        • Parameters

          • value: ServiceObjective
          • index: number
          • array: ServiceObjective[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServiceObjective, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServiceObjective

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServiceObjective, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServiceObjective

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServiceObjective, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServiceObjective

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ServiceObjective, index: number, array: ServiceObjective[]): U
        • Parameters

          • value: ServiceObjective
          • index: number
          • array: ServiceObjective[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ServiceObjective | undefined
  • Removes the last element from an array and returns it.

    Returns ServiceObjective | undefined

push

  • push(...items: ServiceObjective[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ServiceObjective[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ServiceObjective
  • reduce(callbackfn: function, initialValue: ServiceObjective): ServiceObjective
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServiceObjective, currentValue: ServiceObjective, currentIndex: number, array: ServiceObjective[]): ServiceObjective
        • Parameters

          • previousValue: ServiceObjective
          • currentValue: ServiceObjective
          • currentIndex: number
          • array: ServiceObjective[]

          Returns ServiceObjective

    Returns ServiceObjective

  • Parameters

    • callbackfn: function
        • (previousValue: ServiceObjective, currentValue: ServiceObjective, currentIndex: number, array: ServiceObjective[]): ServiceObjective
        • Parameters

          • previousValue: ServiceObjective
          • currentValue: ServiceObjective
          • currentIndex: number
          • array: ServiceObjective[]

          Returns ServiceObjective

    • initialValue: ServiceObjective

    Returns ServiceObjective

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServiceObjective, currentIndex: number, array: ServiceObjective[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServiceObjective
          • currentIndex: number
          • array: ServiceObjective[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ServiceObjective
  • reduceRight(callbackfn: function, initialValue: ServiceObjective): ServiceObjective
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServiceObjective, currentValue: ServiceObjective, currentIndex: number, array: ServiceObjective[]): ServiceObjective
        • Parameters

          • previousValue: ServiceObjective
          • currentValue: ServiceObjective
          • currentIndex: number
          • array: ServiceObjective[]

          Returns ServiceObjective

    Returns ServiceObjective

  • Parameters

    • callbackfn: function
        • (previousValue: ServiceObjective, currentValue: ServiceObjective, currentIndex: number, array: ServiceObjective[]): ServiceObjective
        • Parameters

          • previousValue: ServiceObjective
          • currentValue: ServiceObjective
          • currentIndex: number
          • array: ServiceObjective[]

          Returns ServiceObjective

    • initialValue: ServiceObjective

    Returns ServiceObjective

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServiceObjective, currentIndex: number, array: ServiceObjective[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServiceObjective
          • currentIndex: number
          • array: ServiceObjective[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ServiceObjective[]
  • Reverses the elements in an Array.

    Returns ServiceObjective[]

shift

  • shift(): ServiceObjective | undefined
  • Removes the first element from an array and returns it.

    Returns ServiceObjective | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServiceObjective[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServiceObjective[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ServiceObjective, index: number, array: ServiceObjective[]): boolean
        • Parameters

          • value: ServiceObjective
          • index: number
          • array: ServiceObjective[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ServiceObjective[]
  • splice(start: number, deleteCount: number, ...items: ServiceObjective[]): ServiceObjective[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServiceObjective[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServiceObjective[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServiceObjective[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ServiceObjective[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServiceObjective[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ServiceObjective>
  • Returns an iterable of values in the array

    Returns IterableIterator<ServiceObjective>

type

type: object

className

className: string = "ServiceObjectiveListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceObjective"

name

name: "Composite" = "Composite"

Const ServiceTierAdvisor

ServiceTierAdvisor: object

Represents a Service Tier Advisor.

Optional activeTimeRatio

activeTimeRatio: undefined | number

The activeTimeRatio for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional avgDtu

avgDtu: undefined | number

Gets or sets avgDtu for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional confidence

confidence: undefined | number

Gets or sets confidence for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional currentServiceLevelObjective

currentServiceLevelObjective: undefined | string

Gets or sets currentServiceLevelObjective for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional currentServiceLevelObjectiveId

currentServiceLevelObjectiveId: undefined | string

Gets or sets currentServiceLevelObjectiveId for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseSizeBasedRecommendationServiceLevelObjective

databaseSizeBasedRecommendationServiceLevelObjective: undefined | string

Gets or sets databaseSizeBasedRecommendationServiceLevelObjective for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseSizeBasedRecommendationServiceLevelObjectiveId

databaseSizeBasedRecommendationServiceLevelObjectiveId: undefined | string

Gets or sets databaseSizeBasedRecommendationServiceLevelObjectiveId for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional disasterPlanBasedRecommendationServiceLevelObjective

disasterPlanBasedRecommendationServiceLevelObjective: undefined | string

Gets or sets disasterPlanBasedRecommendationServiceLevelObjective for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional disasterPlanBasedRecommendationServiceLevelObjectiveId

disasterPlanBasedRecommendationServiceLevelObjectiveId: undefined | string

Gets or sets disasterPlanBasedRecommendationServiceLevelObjectiveId for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxDtu

maxDtu: undefined | number

Gets or sets maxDtu for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxSizeInGB

maxSizeInGB: undefined | number

Gets or sets maxSizeInGB for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional minDtu

minDtu: undefined | number

Gets or sets minDtu for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional observationPeriodEnd

observationPeriodEnd: Date

The observation period start (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional observationPeriodStart

observationPeriodStart: Date

The observation period start (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional overallRecommendationServiceLevelObjective

overallRecommendationServiceLevelObjective: undefined | string

Gets or sets overallRecommendationServiceLevelObjective for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional overallRecommendationServiceLevelObjectiveId

overallRecommendationServiceLevelObjectiveId: undefined | string

Gets or sets overallRecommendationServiceLevelObjectiveId for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceTierAdvisor"

Optional serviceLevelObjectiveUsageMetrics

serviceLevelObjectiveUsageMetrics: SloUsageMetric[]

Gets or sets serviceLevelObjectiveUsageMetrics for the service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional usageBasedRecommendationServiceLevelObjective

usageBasedRecommendationServiceLevelObjective: undefined | string

Gets or sets usageBasedRecommendationServiceLevelObjective for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional usageBasedRecommendationServiceLevelObjectiveId

usageBasedRecommendationServiceLevelObjectiveId: undefined | string

Gets or sets usageBasedRecommendationServiceLevelObjectiveId for service tier advisor. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ServiceTierAdvisor"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

activeTimeRatio

activeTimeRatio: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.activeTimeRatio"

type

type: object

name

name: "Number" = "Number"

avgDtu

avgDtu: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.avgDtu"

type

type: object

name

name: "Number" = "Number"

confidence

confidence: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.confidence"

type

type: object

name

name: "Number" = "Number"

currentServiceLevelObjective

currentServiceLevelObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.currentServiceLevelObjective"

type

type: object

name

name: "String" = "String"

currentServiceLevelObjectiveId

currentServiceLevelObjectiveId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.currentServiceLevelObjectiveId"

type

type: object

name

name: "Uuid" = "Uuid"

databaseSizeBasedRecommendationServiceLevelObjective

databaseSizeBasedRecommendationServiceLevelObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseSizeBasedRecommendationServiceLevelObjective"

type

type: object

name

name: "String" = "String"

databaseSizeBasedRecommendationServiceLevelObjectiveId

databaseSizeBasedRecommendationServiceLevelObjectiveId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseSizeBasedRecommendationServiceLevelObjectiveId"

type

type: object

name

name: "Uuid" = "Uuid"

disasterPlanBasedRecommendationServiceLevelObjective

disasterPlanBasedRecommendationServiceLevelObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.disasterPlanBasedRecommendationServiceLevelObjective"

type

type: object

name

name: "String" = "String"

disasterPlanBasedRecommendationServiceLevelObjectiveId

disasterPlanBasedRecommendationServiceLevelObjectiveId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.disasterPlanBasedRecommendationServiceLevelObjectiveId"

type

type: object

name

name: "Uuid" = "Uuid"

maxDtu

maxDtu: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maxDtu"

type

type: object

name

name: "Number" = "Number"

maxSizeInGB

maxSizeInGB: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maxSizeInGB"

type

type: object

name

name: "Number" = "Number"

minDtu

minDtu: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.minDtu"

type

type: object

name

name: "Number" = "Number"

observationPeriodEnd

observationPeriodEnd: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.observationPeriodEnd"

type

type: object

name

name: "DateTime" = "DateTime"

observationPeriodStart

observationPeriodStart: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.observationPeriodStart"

type

type: object

name

name: "DateTime" = "DateTime"

overallRecommendationServiceLevelObjective

overallRecommendationServiceLevelObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.overallRecommendationServiceLevelObjective"

type

type: object

name

name: "String" = "String"

overallRecommendationServiceLevelObjectiveId

overallRecommendationServiceLevelObjectiveId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.overallRecommendationServiceLevelObjectiveId"

type

type: object

name

name: "Uuid" = "Uuid"

serviceLevelObjectiveUsageMetrics

serviceLevelObjectiveUsageMetrics: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serviceLevelObjectiveUsageMetrics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SloUsageMetric"

name

name: "Composite" = "Composite"

usageBasedRecommendationServiceLevelObjective

usageBasedRecommendationServiceLevelObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.usageBasedRecommendationServiceLevelObjective"

type

type: object

name

name: "String" = "String"

usageBasedRecommendationServiceLevelObjectiveId

usageBasedRecommendationServiceLevelObjectiveId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.usageBasedRecommendationServiceLevelObjectiveId"

type

type: object

name

name: "Uuid" = "Uuid"

Const ServiceTierAdvisorListResult

ServiceTierAdvisorListResult: object
interface

Represents the response to a list service tier advisor request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ServiceTierAdvisorListResult"

__@iterator

  • __@iterator(): IterableIterator<ServiceTierAdvisor>
  • Iterator

    Returns IterableIterator<ServiceTierAdvisor>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ServiceTierAdvisor>[]): ServiceTierAdvisor[]
  • concat(...items: (T | ConcatArray<T>)[]): ServiceTierAdvisor[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServiceTierAdvisor>[]

      Additional items to add to the end of array1.

    Returns ServiceTierAdvisor[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServiceTierAdvisor[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ServiceTierAdvisor]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServiceTierAdvisor]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ServiceTierAdvisor, index: number, array: ServiceTierAdvisor[]): boolean
        • Parameters

          • value: ServiceTierAdvisor
          • index: number
          • array: ServiceTierAdvisor[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServiceTierAdvisor, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServiceTierAdvisor

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServiceTierAdvisor[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ServiceTierAdvisor

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServiceTierAdvisor, index: number, array: ServiceTierAdvisor[]): boolean
        • Parameters

          • value: ServiceTierAdvisor
          • index: number
          • array: ServiceTierAdvisor[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServiceTierAdvisor, index: number, array: ServiceTierAdvisor[]): any
        • Parameters

          • value: ServiceTierAdvisor
          • index: number
          • array: ServiceTierAdvisor[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServiceTierAdvisor[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServiceTierAdvisor | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ServiceTierAdvisor

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ServiceTierAdvisor, index: number, obj: ServiceTierAdvisor[]): boolean
        • Parameters

          • this: void
          • value: ServiceTierAdvisor
          • index: number
          • obj: ServiceTierAdvisor[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ServiceTierAdvisor, index: number, obj: ServiceTierAdvisor[]): boolean
        • Parameters

          • value: ServiceTierAdvisor
          • index: number
          • obj: ServiceTierAdvisor[]

          Returns boolean

    • Optional thisArg: any

    Returns ServiceTierAdvisor | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ServiceTierAdvisor, index: number, obj: ServiceTierAdvisor[]): boolean
        • Parameters

          • value: ServiceTierAdvisor
          • index: number
          • obj: ServiceTierAdvisor[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ServiceTierAdvisor, index: number, array: ServiceTierAdvisor[]): void
        • Parameters

          • value: ServiceTierAdvisor
          • index: number
          • array: ServiceTierAdvisor[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServiceTierAdvisor, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServiceTierAdvisor

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServiceTierAdvisor, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServiceTierAdvisor

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServiceTierAdvisor, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServiceTierAdvisor

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ServiceTierAdvisor, index: number, array: ServiceTierAdvisor[]): U
        • Parameters

          • value: ServiceTierAdvisor
          • index: number
          • array: ServiceTierAdvisor[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ServiceTierAdvisor | undefined
  • Removes the last element from an array and returns it.

    Returns ServiceTierAdvisor | undefined

push

  • push(...items: ServiceTierAdvisor[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ServiceTierAdvisor[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ServiceTierAdvisor
  • reduce(callbackfn: function, initialValue: ServiceTierAdvisor): ServiceTierAdvisor
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServiceTierAdvisor, currentValue: ServiceTierAdvisor, currentIndex: number, array: ServiceTierAdvisor[]): ServiceTierAdvisor
        • Parameters

          • previousValue: ServiceTierAdvisor
          • currentValue: ServiceTierAdvisor
          • currentIndex: number
          • array: ServiceTierAdvisor[]

          Returns ServiceTierAdvisor

    Returns ServiceTierAdvisor

  • Parameters

    • callbackfn: function
        • (previousValue: ServiceTierAdvisor, currentValue: ServiceTierAdvisor, currentIndex: number, array: ServiceTierAdvisor[]): ServiceTierAdvisor
        • Parameters

          • previousValue: ServiceTierAdvisor
          • currentValue: ServiceTierAdvisor
          • currentIndex: number
          • array: ServiceTierAdvisor[]

          Returns ServiceTierAdvisor

    • initialValue: ServiceTierAdvisor

    Returns ServiceTierAdvisor

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServiceTierAdvisor, currentIndex: number, array: ServiceTierAdvisor[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServiceTierAdvisor
          • currentIndex: number
          • array: ServiceTierAdvisor[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ServiceTierAdvisor
  • reduceRight(callbackfn: function, initialValue: ServiceTierAdvisor): ServiceTierAdvisor
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServiceTierAdvisor, currentValue: ServiceTierAdvisor, currentIndex: number, array: ServiceTierAdvisor[]): ServiceTierAdvisor
        • Parameters

          • previousValue: ServiceTierAdvisor
          • currentValue: ServiceTierAdvisor
          • currentIndex: number
          • array: ServiceTierAdvisor[]

          Returns ServiceTierAdvisor

    Returns ServiceTierAdvisor

  • Parameters

    • callbackfn: function
        • (previousValue: ServiceTierAdvisor, currentValue: ServiceTierAdvisor, currentIndex: number, array: ServiceTierAdvisor[]): ServiceTierAdvisor
        • Parameters

          • previousValue: ServiceTierAdvisor
          • currentValue: ServiceTierAdvisor
          • currentIndex: number
          • array: ServiceTierAdvisor[]

          Returns ServiceTierAdvisor

    • initialValue: ServiceTierAdvisor

    Returns ServiceTierAdvisor

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServiceTierAdvisor, currentIndex: number, array: ServiceTierAdvisor[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServiceTierAdvisor
          • currentIndex: number
          • array: ServiceTierAdvisor[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ServiceTierAdvisor[]
  • Reverses the elements in an Array.

    Returns ServiceTierAdvisor[]

shift

  • shift(): ServiceTierAdvisor | undefined
  • Removes the first element from an array and returns it.

    Returns ServiceTierAdvisor | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServiceTierAdvisor[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServiceTierAdvisor[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ServiceTierAdvisor, index: number, array: ServiceTierAdvisor[]): boolean
        • Parameters

          • value: ServiceTierAdvisor
          • index: number
          • array: ServiceTierAdvisor[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ServiceTierAdvisor[]
  • splice(start: number, deleteCount: number, ...items: ServiceTierAdvisor[]): ServiceTierAdvisor[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServiceTierAdvisor[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServiceTierAdvisor[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServiceTierAdvisor[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ServiceTierAdvisor[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServiceTierAdvisor[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ServiceTierAdvisor>
  • Returns an iterable of values in the array

    Returns IterableIterator<ServiceTierAdvisor>

type

type: object

className

className: string = "ServiceTierAdvisorListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceTierAdvisor"

name

name: "Composite" = "Composite"

Const Sku

Sku: object

The resource model definition representing SKU

Optional capacity

capacity: undefined | number

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

Optional family

family: undefined | string

If the service has different generations of hardware, for the same SKU, then that can be captured here.

name

name: string

The name of the SKU. Ex - P3. It is typically a letter+number code

serializedName

serializedName: string = "Sku"

Optional size

size: undefined | string

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

Optional tier

tier: undefined | string

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capacity

capacity: object

serializedName

serializedName: string = "capacity"

type

type: object

name

name: "Number" = "Number"

family

family: object

serializedName

serializedName: string = "family"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

size

size: object

serializedName

serializedName: string = "size"

type

type: object

name

name: "String" = "String"

tier

tier: object

serializedName

serializedName: string = "tier"

type

type: object

name

name: "String" = "String"

Const SloUsageMetric

SloUsageMetric: object

A Slo Usage Metric.

Optional inRangeTimeRatio

inRangeTimeRatio: undefined | number

Gets or sets inRangeTimeRatio for SLO usage metric. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SloUsageMetric"

Optional serviceLevelObjective

serviceLevelObjective: ServiceObjectiveName

The serviceLevelObjective for SLO usage metric. Possible values include: 'System', 'System0', 'System1', 'System2', 'System3', 'System4', 'System2L', 'System3L', 'System4L', 'Free', 'Basic', 'S0', 'S1', 'S2', 'S3', 'S4', 'S6', 'S7', 'S9', 'S12', 'P1', 'P2', 'P3', 'P4', 'P6', 'P11', 'P15', 'PRS1', 'PRS2', 'PRS4', 'PRS6', 'DW100', 'DW200', 'DW300', 'DW400', 'DW500', 'DW600', 'DW1000', 'DW1200', 'DW1000c', 'DW1500', 'DW1500c', 'DW2000', 'DW2000c', 'DW3000', 'DW2500c', 'DW3000c', 'DW6000', 'DW5000c', 'DW6000c', 'DW7500c', 'DW10000c', 'DW15000c', 'DW30000c', 'DS100', 'DS200', 'DS300', 'DS400', 'DS500', 'DS600', 'DS1000', 'DS1200', 'DS1500', 'DS2000', 'ElasticPool' NOTE: This property will not be serialized. It can only be populated by the server.

Optional serviceLevelObjectiveId

serviceLevelObjectiveId: undefined | string

The serviceLevelObjectiveId for SLO usage metric. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SloUsageMetric"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

inRangeTimeRatio

inRangeTimeRatio: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "inRangeTimeRatio"

type

type: object

name

name: "Number" = "Number"

serviceLevelObjective

serviceLevelObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "serviceLevelObjective"

type

type: object

name

name: "String" = "String"

serviceLevelObjectiveId

serviceLevelObjectiveId: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "serviceLevelObjectiveId"

type

type: object

name

name: "Uuid" = "Uuid"

Const SubscriptionUsage

SubscriptionUsage: object

Usage Metric of a Subscription in a Location.

Optional currentValue

currentValue: undefined | number

Current value of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional displayName

displayName: undefined | string

User-readable name of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional limit

limit: undefined | number

Boundary value of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SubscriptionUsage"

Optional unit

unit: undefined | string

Unit of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SubscriptionUsage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentValue

currentValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.currentValue"

type

type: object

name

name: "Number" = "Number"

displayName

displayName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "String" = "String"

limit

limit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.limit"

type

type: object

name

name: "Number" = "Number"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.unit"

type

type: object

name

name: "String" = "String"

Const SubscriptionUsageListResult

SubscriptionUsageListResult: object
interface

A list of subscription usage metrics in a location.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SubscriptionUsageListResult"

__@iterator

  • __@iterator(): IterableIterator<SubscriptionUsage>
  • Iterator

    Returns IterableIterator<SubscriptionUsage>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SubscriptionUsage>[]): SubscriptionUsage[]
  • concat(...items: (T | ConcatArray<T>)[]): SubscriptionUsage[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SubscriptionUsage>[]

      Additional items to add to the end of array1.

    Returns SubscriptionUsage[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SubscriptionUsage[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SubscriptionUsage]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SubscriptionUsage]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SubscriptionUsage, index: number, array: SubscriptionUsage[]): boolean
        • Parameters

          • value: SubscriptionUsage
          • index: number
          • array: SubscriptionUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SubscriptionUsage, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SubscriptionUsage

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SubscriptionUsage[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SubscriptionUsage

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SubscriptionUsage, index: number, array: SubscriptionUsage[]): boolean
        • Parameters

          • value: SubscriptionUsage
          • index: number
          • array: SubscriptionUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SubscriptionUsage, index: number, array: SubscriptionUsage[]): any
        • Parameters

          • value: SubscriptionUsage
          • index: number
          • array: SubscriptionUsage[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SubscriptionUsage[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SubscriptionUsage | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SubscriptionUsage

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SubscriptionUsage, index: number, obj: SubscriptionUsage[]): boolean
        • Parameters

          • this: void
          • value: SubscriptionUsage
          • index: number
          • obj: SubscriptionUsage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SubscriptionUsage, index: number, obj: SubscriptionUsage[]): boolean
        • Parameters

          • value: SubscriptionUsage
          • index: number
          • obj: SubscriptionUsage[]

          Returns boolean

    • Optional thisArg: any

    Returns SubscriptionUsage | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SubscriptionUsage, index: number, obj: SubscriptionUsage[]): boolean
        • Parameters

          • value: SubscriptionUsage
          • index: number
          • obj: SubscriptionUsage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SubscriptionUsage, index: number, array: SubscriptionUsage[]): void
        • Parameters

          • value: SubscriptionUsage
          • index: number
          • array: SubscriptionUsage[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SubscriptionUsage, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SubscriptionUsage

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SubscriptionUsage, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SubscriptionUsage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SubscriptionUsage, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SubscriptionUsage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SubscriptionUsage, index: number, array: SubscriptionUsage[]): U
        • Parameters

          • value: SubscriptionUsage
          • index: number
          • array: SubscriptionUsage[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SubscriptionUsage | undefined
  • Removes the last element from an array and returns it.

    Returns SubscriptionUsage | undefined

push

  • push(...items: SubscriptionUsage[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SubscriptionUsage[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SubscriptionUsage
  • reduce(callbackfn: function, initialValue: SubscriptionUsage): SubscriptionUsage
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SubscriptionUsage, currentValue: SubscriptionUsage, currentIndex: number, array: SubscriptionUsage[]): SubscriptionUsage
        • Parameters

          • previousValue: SubscriptionUsage
          • currentValue: SubscriptionUsage
          • currentIndex: number
          • array: SubscriptionUsage[]

          Returns SubscriptionUsage

    Returns SubscriptionUsage

  • Parameters

    • callbackfn: function
        • (previousValue: SubscriptionUsage, currentValue: SubscriptionUsage, currentIndex: number, array: SubscriptionUsage[]): SubscriptionUsage
        • Parameters

          • previousValue: SubscriptionUsage
          • currentValue: SubscriptionUsage
          • currentIndex: number
          • array: SubscriptionUsage[]

          Returns SubscriptionUsage

    • initialValue: SubscriptionUsage

    Returns SubscriptionUsage

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SubscriptionUsage, currentIndex: number, array: SubscriptionUsage[]): U
        • Parameters

          • previousValue: U
          • currentValue: SubscriptionUsage
          • currentIndex: number
          • array: SubscriptionUsage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SubscriptionUsage
  • reduceRight(callbackfn: function, initialValue: SubscriptionUsage): SubscriptionUsage
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SubscriptionUsage, currentValue: SubscriptionUsage, currentIndex: number, array: SubscriptionUsage[]): SubscriptionUsage
        • Parameters

          • previousValue: SubscriptionUsage
          • currentValue: SubscriptionUsage
          • currentIndex: number
          • array: SubscriptionUsage[]

          Returns SubscriptionUsage

    Returns SubscriptionUsage

  • Parameters

    • callbackfn: function
        • (previousValue: SubscriptionUsage, currentValue: SubscriptionUsage, currentIndex: number, array: SubscriptionUsage[]): SubscriptionUsage
        • Parameters

          • previousValue: SubscriptionUsage
          • currentValue: SubscriptionUsage
          • currentIndex: number
          • array: SubscriptionUsage[]

          Returns SubscriptionUsage

    • initialValue: SubscriptionUsage

    Returns SubscriptionUsage

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SubscriptionUsage, currentIndex: number, array: SubscriptionUsage[]): U
        • Parameters

          • previousValue: U
          • currentValue: SubscriptionUsage
          • currentIndex: number
          • array: SubscriptionUsage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SubscriptionUsage[]
  • Reverses the elements in an Array.

    Returns SubscriptionUsage[]

shift

  • shift(): SubscriptionUsage | undefined
  • Removes the first element from an array and returns it.

    Returns SubscriptionUsage | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SubscriptionUsage[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SubscriptionUsage[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SubscriptionUsage, index: number, array: SubscriptionUsage[]): boolean
        • Parameters

          • value: SubscriptionUsage
          • index: number
          • array: SubscriptionUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SubscriptionUsage[]
  • splice(start: number, deleteCount: number, ...items: SubscriptionUsage[]): SubscriptionUsage[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SubscriptionUsage[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SubscriptionUsage[]

      Elements to insert into the array in place of the deleted elements.

    Returns SubscriptionUsage[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SubscriptionUsage[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SubscriptionUsage[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SubscriptionUsage>
  • Returns an iterable of values in the array

    Returns IterableIterator<SubscriptionUsage>

type

type: object

className

className: string = "SubscriptionUsageListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubscriptionUsage"

name

name: "Composite" = "Composite"

Const SyncAgent

SyncAgent: object

An Azure SQL Database sync agent.

Optional expiryTime

expiryTime: Date

Expiration time of the sync agent version. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isUpToDate

isUpToDate: undefined | false | true

If the sync agent version is up to date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastAliveTime

lastAliveTime: Date

Last alive time of the sync agent. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncAgent"

Optional state

State of the sync agent. Possible values include: 'Online', 'Offline', 'NeverConnected' NOTE: This property will not be serialized. It can only be populated by the server.

Optional syncAgentName

syncAgentName: undefined | string

Name of the sync agent. NOTE: This property will not be serialized. It can only be populated by the server.

Optional syncDatabaseId

syncDatabaseId: undefined | string

ARM resource id of the sync database in the sync agent.

Optional version

version: undefined | string

Version of the sync agent. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SyncAgent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiryTime

expiryTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.expiryTime"

type

type: object

name

name: "DateTime" = "DateTime"

isUpToDate

isUpToDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isUpToDate"

type

type: object

name

name: "Boolean" = "Boolean"

lastAliveTime

lastAliveTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastAliveTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

syncAgentName

syncAgentName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.name"

type

type: object

name

name: "String" = "String"

syncDatabaseId

syncDatabaseId: object

serializedName

serializedName: string = "properties.syncDatabaseId"

type

type: object

name

name: "String" = "String"

version

version: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.version"

type

type: object

name

name: "String" = "String"

Const SyncAgentKeyProperties

SyncAgentKeyProperties: object

Properties of an Azure SQL Database sync agent key.

serializedName

serializedName: string = "SyncAgentKeyProperties"

Optional syncAgentKey

syncAgentKey: undefined | string

Key of sync agent. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SyncAgentKeyProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

syncAgentKey

syncAgentKey: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "syncAgentKey"

type

type: object

name

name: "String" = "String"

Const SyncAgentLinkedDatabase

SyncAgentLinkedDatabase: object

An Azure SQL Database sync agent linked database.

Optional databaseId

databaseId: undefined | string

Id of the sync agent linked database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseName

databaseName: undefined | string

Database name of the sync agent linked database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseType

databaseType: SyncMemberDbType

Type of the sync agent linked database. Possible values include: 'AzureSqlDatabase', 'SqlServerDatabase' NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

Description of the sync agent linked database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncAgentLinkedDatabase"

Optional serverName

serverName: undefined | string

Server name of the sync agent linked database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional userName

userName: undefined | string

User name of the sync agent linked database. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SyncAgentLinkedDatabase"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

databaseId

databaseId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseId"

type

type: object

name

name: "String" = "String"

databaseName

databaseName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseName"

type

type: object

name

name: "String" = "String"

databaseType

databaseType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseType"

type

type: object

name

name: "String" = "String"

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

serverName

serverName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serverName"

type

type: object

name

name: "String" = "String"

userName

userName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.userName"

type

type: object

name

name: "String" = "String"

Const SyncAgentLinkedDatabaseListResult

SyncAgentLinkedDatabaseListResult: object
interface

A list of sync agent linked databases.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncAgentLinkedDatabaseListResult"

__@iterator

  • __@iterator(): IterableIterator<SyncAgentLinkedDatabase>
  • Iterator

    Returns IterableIterator<SyncAgentLinkedDatabase>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SyncAgentLinkedDatabase>[]): SyncAgentLinkedDatabase[]
  • concat(...items: (T | ConcatArray<T>)[]): SyncAgentLinkedDatabase[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SyncAgentLinkedDatabase>[]

      Additional items to add to the end of array1.

    Returns SyncAgentLinkedDatabase[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SyncAgentLinkedDatabase[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SyncAgentLinkedDatabase]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SyncAgentLinkedDatabase]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SyncAgentLinkedDatabase, index: number, array: SyncAgentLinkedDatabase[]): boolean
        • Parameters

          • value: SyncAgentLinkedDatabase
          • index: number
          • array: SyncAgentLinkedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SyncAgentLinkedDatabase, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SyncAgentLinkedDatabase

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SyncAgentLinkedDatabase[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SyncAgentLinkedDatabase

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncAgentLinkedDatabase, index: number, array: SyncAgentLinkedDatabase[]): boolean
        • Parameters

          • value: SyncAgentLinkedDatabase
          • index: number
          • array: SyncAgentLinkedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncAgentLinkedDatabase, index: number, array: SyncAgentLinkedDatabase[]): any
        • Parameters

          • value: SyncAgentLinkedDatabase
          • index: number
          • array: SyncAgentLinkedDatabase[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SyncAgentLinkedDatabase[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SyncAgentLinkedDatabase | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SyncAgentLinkedDatabase

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SyncAgentLinkedDatabase, index: number, obj: SyncAgentLinkedDatabase[]): boolean
        • Parameters

          • this: void
          • value: SyncAgentLinkedDatabase
          • index: number
          • obj: SyncAgentLinkedDatabase[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SyncAgentLinkedDatabase, index: number, obj: SyncAgentLinkedDatabase[]): boolean
        • Parameters

          • value: SyncAgentLinkedDatabase
          • index: number
          • obj: SyncAgentLinkedDatabase[]

          Returns boolean

    • Optional thisArg: any

    Returns SyncAgentLinkedDatabase | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SyncAgentLinkedDatabase, index: number, obj: SyncAgentLinkedDatabase[]): boolean
        • Parameters

          • value: SyncAgentLinkedDatabase
          • index: number
          • obj: SyncAgentLinkedDatabase[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SyncAgentLinkedDatabase, index: number, array: SyncAgentLinkedDatabase[]): void
        • Parameters

          • value: SyncAgentLinkedDatabase
          • index: number
          • array: SyncAgentLinkedDatabase[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SyncAgentLinkedDatabase, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SyncAgentLinkedDatabase

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SyncAgentLinkedDatabase, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SyncAgentLinkedDatabase

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SyncAgentLinkedDatabase, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SyncAgentLinkedDatabase

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SyncAgentLinkedDatabase, index: number, array: SyncAgentLinkedDatabase[]): U
        • Parameters

          • value: SyncAgentLinkedDatabase
          • index: number
          • array: SyncAgentLinkedDatabase[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SyncAgentLinkedDatabase | undefined
  • Removes the last element from an array and returns it.

    Returns SyncAgentLinkedDatabase | undefined

push

  • push(...items: SyncAgentLinkedDatabase[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SyncAgentLinkedDatabase[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SyncAgentLinkedDatabase
  • reduce(callbackfn: function, initialValue: SyncAgentLinkedDatabase): SyncAgentLinkedDatabase
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncAgentLinkedDatabase, currentValue: SyncAgentLinkedDatabase, currentIndex: number, array: SyncAgentLinkedDatabase[]): SyncAgentLinkedDatabase
        • Parameters

          • previousValue: SyncAgentLinkedDatabase
          • currentValue: SyncAgentLinkedDatabase
          • currentIndex: number
          • array: SyncAgentLinkedDatabase[]

          Returns SyncAgentLinkedDatabase

    Returns SyncAgentLinkedDatabase

  • Parameters

    • callbackfn: function
        • (previousValue: SyncAgentLinkedDatabase, currentValue: SyncAgentLinkedDatabase, currentIndex: number, array: SyncAgentLinkedDatabase[]): SyncAgentLinkedDatabase
        • Parameters

          • previousValue: SyncAgentLinkedDatabase
          • currentValue: SyncAgentLinkedDatabase
          • currentIndex: number
          • array: SyncAgentLinkedDatabase[]

          Returns SyncAgentLinkedDatabase

    • initialValue: SyncAgentLinkedDatabase

    Returns SyncAgentLinkedDatabase

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncAgentLinkedDatabase, currentIndex: number, array: SyncAgentLinkedDatabase[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncAgentLinkedDatabase
          • currentIndex: number
          • array: SyncAgentLinkedDatabase[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SyncAgentLinkedDatabase
  • reduceRight(callbackfn: function, initialValue: SyncAgentLinkedDatabase): SyncAgentLinkedDatabase
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncAgentLinkedDatabase, currentValue: SyncAgentLinkedDatabase, currentIndex: number, array: SyncAgentLinkedDatabase[]): SyncAgentLinkedDatabase
        • Parameters

          • previousValue: SyncAgentLinkedDatabase
          • currentValue: SyncAgentLinkedDatabase
          • currentIndex: number
          • array: SyncAgentLinkedDatabase[]

          Returns SyncAgentLinkedDatabase

    Returns SyncAgentLinkedDatabase

  • Parameters

    • callbackfn: function
        • (previousValue: SyncAgentLinkedDatabase, currentValue: SyncAgentLinkedDatabase, currentIndex: number, array: SyncAgentLinkedDatabase[]): SyncAgentLinkedDatabase
        • Parameters

          • previousValue: SyncAgentLinkedDatabase
          • currentValue: SyncAgentLinkedDatabase
          • currentIndex: number
          • array: SyncAgentLinkedDatabase[]

          Returns SyncAgentLinkedDatabase

    • initialValue: SyncAgentLinkedDatabase

    Returns SyncAgentLinkedDatabase

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncAgentLinkedDatabase, currentIndex: number, array: SyncAgentLinkedDatabase[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncAgentLinkedDatabase
          • currentIndex: number
          • array: SyncAgentLinkedDatabase[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SyncAgentLinkedDatabase[]
  • Reverses the elements in an Array.

    Returns SyncAgentLinkedDatabase[]

shift

  • shift(): SyncAgentLinkedDatabase | undefined
  • Removes the first element from an array and returns it.

    Returns SyncAgentLinkedDatabase | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SyncAgentLinkedDatabase[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SyncAgentLinkedDatabase[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SyncAgentLinkedDatabase, index: number, array: SyncAgentLinkedDatabase[]): boolean
        • Parameters

          • value: SyncAgentLinkedDatabase
          • index: number
          • array: SyncAgentLinkedDatabase[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SyncAgentLinkedDatabase[]
  • splice(start: number, deleteCount: number, ...items: SyncAgentLinkedDatabase[]): SyncAgentLinkedDatabase[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SyncAgentLinkedDatabase[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SyncAgentLinkedDatabase[]

      Elements to insert into the array in place of the deleted elements.

    Returns SyncAgentLinkedDatabase[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SyncAgentLinkedDatabase[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SyncAgentLinkedDatabase[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SyncAgentLinkedDatabase>
  • Returns an iterable of values in the array

    Returns IterableIterator<SyncAgentLinkedDatabase>

type

type: object

className

className: string = "SyncAgentLinkedDatabaseListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SyncAgentLinkedDatabase"

name

name: "Composite" = "Composite"

Const SyncAgentListResult

SyncAgentListResult: object
interface

A list of sync agents.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncAgentListResult"

__@iterator

  • __@iterator(): IterableIterator<SyncAgent>
  • Iterator

    Returns IterableIterator<SyncAgent>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SyncAgent>[]): SyncAgent[]
  • concat(...items: (T | ConcatArray<T>)[]): SyncAgent[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SyncAgent>[]

      Additional items to add to the end of array1.

    Returns SyncAgent[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SyncAgent[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SyncAgent]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SyncAgent]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SyncAgent, index: number, array: SyncAgent[]): boolean
        • Parameters

          • value: SyncAgent
          • index: number
          • array: SyncAgent[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SyncAgent, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SyncAgent

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SyncAgent[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SyncAgent

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncAgent, index: number, array: SyncAgent[]): boolean
        • Parameters

          • value: SyncAgent
          • index: number
          • array: SyncAgent[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncAgent, index: number, array: SyncAgent[]): any
        • Parameters

          • value: SyncAgent
          • index: number
          • array: SyncAgent[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SyncAgent[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SyncAgent | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SyncAgent

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SyncAgent, index: number, obj: SyncAgent[]): boolean
        • Parameters

          • this: void
          • value: SyncAgent
          • index: number
          • obj: SyncAgent[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SyncAgent, index: number, obj: SyncAgent[]): boolean
        • Parameters

          • value: SyncAgent
          • index: number
          • obj: SyncAgent[]

          Returns boolean

    • Optional thisArg: any

    Returns SyncAgent | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SyncAgent, index: number, obj: SyncAgent[]): boolean
        • Parameters

          • value: SyncAgent
          • index: number
          • obj: SyncAgent[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SyncAgent, index: number, array: SyncAgent[]): void
        • Parameters

          • value: SyncAgent
          • index: number
          • array: SyncAgent[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SyncAgent, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SyncAgent

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SyncAgent, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SyncAgent

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SyncAgent, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SyncAgent

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SyncAgent, index: number, array: SyncAgent[]): U
        • Parameters

          • value: SyncAgent
          • index: number
          • array: SyncAgent[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SyncAgent | undefined
  • Removes the last element from an array and returns it.

    Returns SyncAgent | undefined

push

  • push(...items: SyncAgent[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SyncAgent[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SyncAgent
  • reduce(callbackfn: function, initialValue: SyncAgent): SyncAgent
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncAgent, currentValue: SyncAgent, currentIndex: number, array: SyncAgent[]): SyncAgent
        • Parameters

          • previousValue: SyncAgent
          • currentValue: SyncAgent
          • currentIndex: number
          • array: SyncAgent[]

          Returns SyncAgent

    Returns SyncAgent

  • Parameters

    • callbackfn: function
        • (previousValue: SyncAgent, currentValue: SyncAgent, currentIndex: number, array: SyncAgent[]): SyncAgent
        • Parameters

          • previousValue: SyncAgent
          • currentValue: SyncAgent
          • currentIndex: number
          • array: SyncAgent[]

          Returns SyncAgent

    • initialValue: SyncAgent

    Returns SyncAgent

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncAgent, currentIndex: number, array: SyncAgent[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncAgent
          • currentIndex: number
          • array: SyncAgent[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SyncAgent
  • reduceRight(callbackfn: function, initialValue: SyncAgent): SyncAgent
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncAgent, currentValue: SyncAgent, currentIndex: number, array: SyncAgent[]): SyncAgent
        • Parameters

          • previousValue: SyncAgent
          • currentValue: SyncAgent
          • currentIndex: number
          • array: SyncAgent[]

          Returns SyncAgent

    Returns SyncAgent

  • Parameters

    • callbackfn: function
        • (previousValue: SyncAgent, currentValue: SyncAgent, currentIndex: number, array: SyncAgent[]): SyncAgent
        • Parameters

          • previousValue: SyncAgent
          • currentValue: SyncAgent
          • currentIndex: number
          • array: SyncAgent[]

          Returns SyncAgent

    • initialValue: SyncAgent

    Returns SyncAgent

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncAgent, currentIndex: number, array: SyncAgent[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncAgent
          • currentIndex: number
          • array: SyncAgent[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SyncAgent[]
  • Reverses the elements in an Array.

    Returns SyncAgent[]

shift

  • shift(): SyncAgent | undefined
  • Removes the first element from an array and returns it.

    Returns SyncAgent | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SyncAgent[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SyncAgent[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SyncAgent, index: number, array: SyncAgent[]): boolean
        • Parameters

          • value: SyncAgent
          • index: number
          • array: SyncAgent[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SyncAgent[]
  • splice(start: number, deleteCount: number, ...items: SyncAgent[]): SyncAgent[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SyncAgent[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SyncAgent[]

      Elements to insert into the array in place of the deleted elements.

    Returns SyncAgent[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SyncAgent[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SyncAgent[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SyncAgent>
  • Returns an iterable of values in the array

    Returns IterableIterator<SyncAgent>

type

type: object

className

className: string = "SyncAgentListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SyncAgent"

name

name: "Composite" = "Composite"

Const SyncDatabaseIdListResult

SyncDatabaseIdListResult: object
interface

A list of sync database ID properties.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncDatabaseIdListResult"

__@iterator

  • __@iterator(): IterableIterator<SyncDatabaseIdProperties>
  • Iterator

    Returns IterableIterator<SyncDatabaseIdProperties>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SyncDatabaseIdProperties>[]): SyncDatabaseIdProperties[]
  • concat(...items: (T | ConcatArray<T>)[]): SyncDatabaseIdProperties[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SyncDatabaseIdProperties>[]

      Additional items to add to the end of array1.

    Returns SyncDatabaseIdProperties[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SyncDatabaseIdProperties[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SyncDatabaseIdProperties]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SyncDatabaseIdProperties]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SyncDatabaseIdProperties, index: number, array: SyncDatabaseIdProperties[]): boolean
        • Parameters

          • value: SyncDatabaseIdProperties
          • index: number
          • array: SyncDatabaseIdProperties[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SyncDatabaseIdProperties, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SyncDatabaseIdProperties

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SyncDatabaseIdProperties[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SyncDatabaseIdProperties

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncDatabaseIdProperties, index: number, array: SyncDatabaseIdProperties[]): boolean
        • Parameters

          • value: SyncDatabaseIdProperties
          • index: number
          • array: SyncDatabaseIdProperties[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncDatabaseIdProperties, index: number, array: SyncDatabaseIdProperties[]): any
        • Parameters

          • value: SyncDatabaseIdProperties
          • index: number
          • array: SyncDatabaseIdProperties[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SyncDatabaseIdProperties[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SyncDatabaseIdProperties | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SyncDatabaseIdProperties

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SyncDatabaseIdProperties, index: number, obj: SyncDatabaseIdProperties[]): boolean
        • Parameters

          • this: void
          • value: SyncDatabaseIdProperties
          • index: number
          • obj: SyncDatabaseIdProperties[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SyncDatabaseIdProperties, index: number, obj: SyncDatabaseIdProperties[]): boolean
        • Parameters

          • value: SyncDatabaseIdProperties
          • index: number
          • obj: SyncDatabaseIdProperties[]

          Returns boolean

    • Optional thisArg: any

    Returns SyncDatabaseIdProperties | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SyncDatabaseIdProperties, index: number, obj: SyncDatabaseIdProperties[]): boolean
        • Parameters

          • value: SyncDatabaseIdProperties
          • index: number
          • obj: SyncDatabaseIdProperties[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SyncDatabaseIdProperties, index: number, array: SyncDatabaseIdProperties[]): void
        • Parameters

          • value: SyncDatabaseIdProperties
          • index: number
          • array: SyncDatabaseIdProperties[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SyncDatabaseIdProperties, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SyncDatabaseIdProperties

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SyncDatabaseIdProperties, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SyncDatabaseIdProperties

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SyncDatabaseIdProperties, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SyncDatabaseIdProperties

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SyncDatabaseIdProperties, index: number, array: SyncDatabaseIdProperties[]): U
        • Parameters

          • value: SyncDatabaseIdProperties
          • index: number
          • array: SyncDatabaseIdProperties[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SyncDatabaseIdProperties | undefined
  • Removes the last element from an array and returns it.

    Returns SyncDatabaseIdProperties | undefined

push

  • push(...items: SyncDatabaseIdProperties[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SyncDatabaseIdProperties[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SyncDatabaseIdProperties
  • reduce(callbackfn: function, initialValue: SyncDatabaseIdProperties): SyncDatabaseIdProperties
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncDatabaseIdProperties, currentValue: SyncDatabaseIdProperties, currentIndex: number, array: SyncDatabaseIdProperties[]): SyncDatabaseIdProperties
        • Parameters

          • previousValue: SyncDatabaseIdProperties
          • currentValue: SyncDatabaseIdProperties
          • currentIndex: number
          • array: SyncDatabaseIdProperties[]

          Returns SyncDatabaseIdProperties

    Returns SyncDatabaseIdProperties

  • Parameters

    • callbackfn: function
        • (previousValue: SyncDatabaseIdProperties, currentValue: SyncDatabaseIdProperties, currentIndex: number, array: SyncDatabaseIdProperties[]): SyncDatabaseIdProperties
        • Parameters

          • previousValue: SyncDatabaseIdProperties
          • currentValue: SyncDatabaseIdProperties
          • currentIndex: number
          • array: SyncDatabaseIdProperties[]

          Returns SyncDatabaseIdProperties

    • initialValue: SyncDatabaseIdProperties

    Returns SyncDatabaseIdProperties

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncDatabaseIdProperties, currentIndex: number, array: SyncDatabaseIdProperties[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncDatabaseIdProperties
          • currentIndex: number
          • array: SyncDatabaseIdProperties[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SyncDatabaseIdProperties
  • reduceRight(callbackfn: function, initialValue: SyncDatabaseIdProperties): SyncDatabaseIdProperties
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncDatabaseIdProperties, currentValue: SyncDatabaseIdProperties, currentIndex: number, array: SyncDatabaseIdProperties[]): SyncDatabaseIdProperties
        • Parameters

          • previousValue: SyncDatabaseIdProperties
          • currentValue: SyncDatabaseIdProperties
          • currentIndex: number
          • array: SyncDatabaseIdProperties[]

          Returns SyncDatabaseIdProperties

    Returns SyncDatabaseIdProperties

  • Parameters

    • callbackfn: function
        • (previousValue: SyncDatabaseIdProperties, currentValue: SyncDatabaseIdProperties, currentIndex: number, array: SyncDatabaseIdProperties[]): SyncDatabaseIdProperties
        • Parameters

          • previousValue: SyncDatabaseIdProperties
          • currentValue: SyncDatabaseIdProperties
          • currentIndex: number
          • array: SyncDatabaseIdProperties[]

          Returns SyncDatabaseIdProperties

    • initialValue: SyncDatabaseIdProperties

    Returns SyncDatabaseIdProperties

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncDatabaseIdProperties, currentIndex: number, array: SyncDatabaseIdProperties[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncDatabaseIdProperties
          • currentIndex: number
          • array: SyncDatabaseIdProperties[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SyncDatabaseIdProperties[]
  • Reverses the elements in an Array.

    Returns SyncDatabaseIdProperties[]

shift

  • shift(): SyncDatabaseIdProperties | undefined
  • Removes the first element from an array and returns it.

    Returns SyncDatabaseIdProperties | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SyncDatabaseIdProperties[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SyncDatabaseIdProperties[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SyncDatabaseIdProperties, index: number, array: SyncDatabaseIdProperties[]): boolean
        • Parameters

          • value: SyncDatabaseIdProperties
          • index: number
          • array: SyncDatabaseIdProperties[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SyncDatabaseIdProperties[]
  • splice(start: number, deleteCount: number, ...items: SyncDatabaseIdProperties[]): SyncDatabaseIdProperties[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SyncDatabaseIdProperties[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SyncDatabaseIdProperties[]

      Elements to insert into the array in place of the deleted elements.

    Returns SyncDatabaseIdProperties[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SyncDatabaseIdProperties[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SyncDatabaseIdProperties[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SyncDatabaseIdProperties>
  • Returns an iterable of values in the array

    Returns IterableIterator<SyncDatabaseIdProperties>

type

type: object

className

className: string = "SyncDatabaseIdListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SyncDatabaseIdProperties"

name

name: "Composite" = "Composite"

Const SyncDatabaseIdProperties

SyncDatabaseIdProperties: object

Properties of the sync database id.

Optional id

id: undefined | string

ARM resource id of sync database. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncDatabaseIdProperties"

type

type: object

className

className: string = "SyncDatabaseIdProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const SyncFullSchemaProperties

SyncFullSchemaProperties: object

Properties of the database full schema.

Optional lastUpdateTime

lastUpdateTime: Date

Last update time of the database schema. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncFullSchemaProperties"

Optional tables

tables: SyncFullSchemaTable[]

List of tables in the database full schema. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SyncFullSchemaProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lastUpdateTime

lastUpdateTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastUpdateTime"

type

type: object

name

name: "DateTime" = "DateTime"

tables

tables: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tables"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SyncFullSchemaTable"

name

name: "Composite" = "Composite"

Const SyncFullSchemaPropertiesListResult

SyncFullSchemaPropertiesListResult: object
interface

A list of sync schema properties.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncFullSchemaPropertiesListResult"

__@iterator

  • __@iterator(): IterableIterator<SyncFullSchemaProperties>
  • Iterator

    Returns IterableIterator<SyncFullSchemaProperties>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SyncFullSchemaProperties>[]): SyncFullSchemaProperties[]
  • concat(...items: (T | ConcatArray<T>)[]): SyncFullSchemaProperties[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SyncFullSchemaProperties>[]

      Additional items to add to the end of array1.

    Returns SyncFullSchemaProperties[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SyncFullSchemaProperties[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SyncFullSchemaProperties]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SyncFullSchemaProperties]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SyncFullSchemaProperties, index: number, array: SyncFullSchemaProperties[]): boolean
        • Parameters

          • value: SyncFullSchemaProperties
          • index: number
          • array: SyncFullSchemaProperties[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SyncFullSchemaProperties, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SyncFullSchemaProperties

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SyncFullSchemaProperties[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SyncFullSchemaProperties

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncFullSchemaProperties, index: number, array: SyncFullSchemaProperties[]): boolean
        • Parameters

          • value: SyncFullSchemaProperties
          • index: number
          • array: SyncFullSchemaProperties[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncFullSchemaProperties, index: number, array: SyncFullSchemaProperties[]): any
        • Parameters

          • value: SyncFullSchemaProperties
          • index: number
          • array: SyncFullSchemaProperties[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SyncFullSchemaProperties[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SyncFullSchemaProperties | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SyncFullSchemaProperties

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SyncFullSchemaProperties, index: number, obj: SyncFullSchemaProperties[]): boolean
        • Parameters

          • this: void
          • value: SyncFullSchemaProperties
          • index: number
          • obj: SyncFullSchemaProperties[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SyncFullSchemaProperties, index: number, obj: SyncFullSchemaProperties[]): boolean
        • Parameters

          • value: SyncFullSchemaProperties
          • index: number
          • obj: SyncFullSchemaProperties[]

          Returns boolean

    • Optional thisArg: any

    Returns SyncFullSchemaProperties | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SyncFullSchemaProperties, index: number, obj: SyncFullSchemaProperties[]): boolean
        • Parameters

          • value: SyncFullSchemaProperties
          • index: number
          • obj: SyncFullSchemaProperties[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SyncFullSchemaProperties, index: number, array: SyncFullSchemaProperties[]): void
        • Parameters

          • value: SyncFullSchemaProperties
          • index: number
          • array: SyncFullSchemaProperties[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SyncFullSchemaProperties, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SyncFullSchemaProperties

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SyncFullSchemaProperties, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SyncFullSchemaProperties

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SyncFullSchemaProperties, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SyncFullSchemaProperties

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SyncFullSchemaProperties, index: number, array: SyncFullSchemaProperties[]): U
        • Parameters

          • value: SyncFullSchemaProperties
          • index: number
          • array: SyncFullSchemaProperties[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SyncFullSchemaProperties | undefined
  • Removes the last element from an array and returns it.

    Returns SyncFullSchemaProperties | undefined

push

  • push(...items: SyncFullSchemaProperties[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SyncFullSchemaProperties[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SyncFullSchemaProperties
  • reduce(callbackfn: function, initialValue: SyncFullSchemaProperties): SyncFullSchemaProperties
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncFullSchemaProperties, currentValue: SyncFullSchemaProperties, currentIndex: number, array: SyncFullSchemaProperties[]): SyncFullSchemaProperties
        • Parameters

          • previousValue: SyncFullSchemaProperties
          • currentValue: SyncFullSchemaProperties
          • currentIndex: number
          • array: SyncFullSchemaProperties[]

          Returns SyncFullSchemaProperties

    Returns SyncFullSchemaProperties

  • Parameters

    • callbackfn: function
        • (previousValue: SyncFullSchemaProperties, currentValue: SyncFullSchemaProperties, currentIndex: number, array: SyncFullSchemaProperties[]): SyncFullSchemaProperties
        • Parameters

          • previousValue: SyncFullSchemaProperties
          • currentValue: SyncFullSchemaProperties
          • currentIndex: number
          • array: SyncFullSchemaProperties[]

          Returns SyncFullSchemaProperties

    • initialValue: SyncFullSchemaProperties

    Returns SyncFullSchemaProperties

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncFullSchemaProperties, currentIndex: number, array: SyncFullSchemaProperties[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncFullSchemaProperties
          • currentIndex: number
          • array: SyncFullSchemaProperties[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SyncFullSchemaProperties
  • reduceRight(callbackfn: function, initialValue: SyncFullSchemaProperties): SyncFullSchemaProperties
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncFullSchemaProperties, currentValue: SyncFullSchemaProperties, currentIndex: number, array: SyncFullSchemaProperties[]): SyncFullSchemaProperties
        • Parameters

          • previousValue: SyncFullSchemaProperties
          • currentValue: SyncFullSchemaProperties
          • currentIndex: number
          • array: SyncFullSchemaProperties[]

          Returns SyncFullSchemaProperties

    Returns SyncFullSchemaProperties

  • Parameters

    • callbackfn: function
        • (previousValue: SyncFullSchemaProperties, currentValue: SyncFullSchemaProperties, currentIndex: number, array: SyncFullSchemaProperties[]): SyncFullSchemaProperties
        • Parameters

          • previousValue: SyncFullSchemaProperties
          • currentValue: SyncFullSchemaProperties
          • currentIndex: number
          • array: SyncFullSchemaProperties[]

          Returns SyncFullSchemaProperties

    • initialValue: SyncFullSchemaProperties

    Returns SyncFullSchemaProperties

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncFullSchemaProperties, currentIndex: number, array: SyncFullSchemaProperties[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncFullSchemaProperties
          • currentIndex: number
          • array: SyncFullSchemaProperties[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SyncFullSchemaProperties[]
  • Reverses the elements in an Array.

    Returns SyncFullSchemaProperties[]

shift

  • shift(): SyncFullSchemaProperties | undefined
  • Removes the first element from an array and returns it.

    Returns SyncFullSchemaProperties | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SyncFullSchemaProperties[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SyncFullSchemaProperties[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SyncFullSchemaProperties, index: number, array: SyncFullSchemaProperties[]): boolean
        • Parameters

          • value: SyncFullSchemaProperties
          • index: number
          • array: SyncFullSchemaProperties[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SyncFullSchemaProperties[]
  • splice(start: number, deleteCount: number, ...items: SyncFullSchemaProperties[]): SyncFullSchemaProperties[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SyncFullSchemaProperties[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SyncFullSchemaProperties[]

      Elements to insert into the array in place of the deleted elements.

    Returns SyncFullSchemaProperties[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SyncFullSchemaProperties[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SyncFullSchemaProperties[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SyncFullSchemaProperties>
  • Returns an iterable of values in the array

    Returns IterableIterator<SyncFullSchemaProperties>

type

type: object

className

className: string = "SyncFullSchemaPropertiesListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SyncFullSchemaProperties"

name

name: "Composite" = "Composite"

Const SyncFullSchemaTable

SyncFullSchemaTable: object

Properties of the table in the database full schema.

Optional columns

columns: SyncFullSchemaTableColumn[]

List of columns in the table of database full schema. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorId

errorId: undefined | string

Error id of the table. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hasError

hasError: undefined | false | true

If there is error in the table. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Name of the table. NOTE: This property will not be serialized. It can only be populated by the server.

Optional quotedName

quotedName: undefined | string

Quoted name of the table. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncFullSchemaTable"

type

type: object

className

className: string = "SyncFullSchemaTable"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

columns

columns: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "columns"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SyncFullSchemaTableColumn"

name

name: "Composite" = "Composite"

errorId

errorId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "errorId"

type

type: object

name

name: "String" = "String"

hasError

hasError: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "hasError"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

quotedName

quotedName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "quotedName"

type

type: object

name

name: "String" = "String"

Const SyncFullSchemaTableColumn

SyncFullSchemaTableColumn: object

Properties of the column in the table of database full schema.

Optional dataSize

dataSize: undefined | string

Data size of the column. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dataType

dataType: undefined | string

Data type of the column. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorId

errorId: undefined | string

Error id of the column. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hasError

hasError: undefined | false | true

If there is error in the table. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isPrimaryKey

isPrimaryKey: undefined | false | true

If it is the primary key of the table. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Name of the column. NOTE: This property will not be serialized. It can only be populated by the server.

Optional quotedName

quotedName: undefined | string

Quoted name of the column. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncFullSchemaTableColumn"

type

type: object

className

className: string = "SyncFullSchemaTableColumn"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dataSize

dataSize: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "dataSize"

type

type: object

name

name: "String" = "String"

dataType

dataType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "dataType"

type

type: object

name

name: "String" = "String"

errorId

errorId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "errorId"

type

type: object

name

name: "String" = "String"

hasError

hasError: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "hasError"

type

type: object

name

name: "Boolean" = "Boolean"

isPrimaryKey

isPrimaryKey: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "isPrimaryKey"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

quotedName

quotedName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "quotedName"

type

type: object

name

name: "String" = "String"

Const SyncGroup

SyncGroup: object

An Azure SQL Database sync group.

Optional conflictResolutionPolicy

conflictResolutionPolicy: SyncConflictResolutionPolicy

Conflict resolution policy of the sync group. Possible values include: 'HubWin', 'MemberWin'

Optional hubDatabasePassword

hubDatabasePassword: undefined | string

Password for the sync group hub database credential.

Optional hubDatabaseUserName

hubDatabaseUserName: undefined | string

User name for the sync group hub database credential.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional interval

interval: undefined | number

Sync interval of the sync group.

Optional lastSyncTime

lastSyncTime: Date

Last sync time of the sync group. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional schema

Sync schema of the sync group.

serializedName

serializedName: string = "SyncGroup"

Optional syncDatabaseId

syncDatabaseId: undefined | string

ARM resource id of the sync database in the sync group.

Optional syncState

syncState: SyncGroupState

Sync state of the sync group. Possible values include: 'NotReady', 'Error', 'Warning', 'Progressing', 'Good' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SyncGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

conflictResolutionPolicy

conflictResolutionPolicy: object

serializedName

serializedName: string = "properties.conflictResolutionPolicy"

type

type: object

name

name: "String" = "String"

hubDatabasePassword

hubDatabasePassword: object

serializedName

serializedName: string = "properties.hubDatabasePassword"

type

type: object

name

name: "String" = "String"

hubDatabaseUserName

hubDatabaseUserName: object

serializedName

serializedName: string = "properties.hubDatabaseUserName"

type

type: object

name

name: "String" = "String"

interval

interval: object

serializedName

serializedName: string = "properties.interval"

type

type: object

name

name: "Number" = "Number"

lastSyncTime

lastSyncTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastSyncTime"

type

type: object

name

name: "DateTime" = "DateTime"

schema

schema: object

serializedName

serializedName: string = "properties.schema"

type

type: object

className

className: string = "SyncGroupSchema"

name

name: "Composite" = "Composite"

syncDatabaseId

syncDatabaseId: object

serializedName

serializedName: string = "properties.syncDatabaseId"

type

type: object

name

name: "String" = "String"

syncState

syncState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.syncState"

type

type: object

name

name: "String" = "String"

Const SyncGroupListResult

SyncGroupListResult: object
interface

A list of sync groups.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncGroupListResult"

__@iterator

  • __@iterator(): IterableIterator<SyncGroup>
  • Iterator

    Returns IterableIterator<SyncGroup>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SyncGroup>[]): SyncGroup[]
  • concat(...items: (T | ConcatArray<T>)[]): SyncGroup[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SyncGroup>[]

      Additional items to add to the end of array1.

    Returns SyncGroup[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SyncGroup[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SyncGroup]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SyncGroup]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SyncGroup, index: number, array: SyncGroup[]): boolean
        • Parameters

          • value: SyncGroup
          • index: number
          • array: SyncGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SyncGroup, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SyncGroup

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SyncGroup[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SyncGroup

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncGroup, index: number, array: SyncGroup[]): boolean
        • Parameters

          • value: SyncGroup
          • index: number
          • array: SyncGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncGroup, index: number, array: SyncGroup[]): any
        • Parameters

          • value: SyncGroup
          • index: number
          • array: SyncGroup[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SyncGroup[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SyncGroup | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SyncGroup

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SyncGroup, index: number, obj: SyncGroup[]): boolean
        • Parameters

          • this: void
          • value: SyncGroup
          • index: number
          • obj: SyncGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SyncGroup, index: number, obj: SyncGroup[]): boolean
        • Parameters

          • value: SyncGroup
          • index: number
          • obj: SyncGroup[]

          Returns boolean

    • Optional thisArg: any

    Returns SyncGroup | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SyncGroup, index: number, obj: SyncGroup[]): boolean
        • Parameters

          • value: SyncGroup
          • index: number
          • obj: SyncGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SyncGroup, index: number, array: SyncGroup[]): void
        • Parameters

          • value: SyncGroup
          • index: number
          • array: SyncGroup[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SyncGroup, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SyncGroup

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SyncGroup, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SyncGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SyncGroup, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SyncGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SyncGroup, index: number, array: SyncGroup[]): U
        • Parameters

          • value: SyncGroup
          • index: number
          • array: SyncGroup[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SyncGroup | undefined
  • Removes the last element from an array and returns it.

    Returns SyncGroup | undefined

push

  • push(...items: SyncGroup[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SyncGroup[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SyncGroup
  • reduce(callbackfn: function, initialValue: SyncGroup): SyncGroup
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncGroup, currentValue: SyncGroup, currentIndex: number, array: SyncGroup[]): SyncGroup
        • Parameters

          • previousValue: SyncGroup
          • currentValue: SyncGroup
          • currentIndex: number
          • array: SyncGroup[]

          Returns SyncGroup

    Returns SyncGroup

  • Parameters

    • callbackfn: function
        • (previousValue: SyncGroup, currentValue: SyncGroup, currentIndex: number, array: SyncGroup[]): SyncGroup
        • Parameters

          • previousValue: SyncGroup
          • currentValue: SyncGroup
          • currentIndex: number
          • array: SyncGroup[]

          Returns SyncGroup

    • initialValue: SyncGroup

    Returns SyncGroup

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncGroup, currentIndex: number, array: SyncGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncGroup
          • currentIndex: number
          • array: SyncGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SyncGroup
  • reduceRight(callbackfn: function, initialValue: SyncGroup): SyncGroup
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncGroup, currentValue: SyncGroup, currentIndex: number, array: SyncGroup[]): SyncGroup
        • Parameters

          • previousValue: SyncGroup
          • currentValue: SyncGroup
          • currentIndex: number
          • array: SyncGroup[]

          Returns SyncGroup

    Returns SyncGroup

  • Parameters

    • callbackfn: function
        • (previousValue: SyncGroup, currentValue: SyncGroup, currentIndex: number, array: SyncGroup[]): SyncGroup
        • Parameters

          • previousValue: SyncGroup
          • currentValue: SyncGroup
          • currentIndex: number
          • array: SyncGroup[]

          Returns SyncGroup

    • initialValue: SyncGroup

    Returns SyncGroup

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncGroup, currentIndex: number, array: SyncGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncGroup
          • currentIndex: number
          • array: SyncGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SyncGroup[]
  • Reverses the elements in an Array.

    Returns SyncGroup[]

shift

  • shift(): SyncGroup | undefined
  • Removes the first element from an array and returns it.

    Returns SyncGroup | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SyncGroup[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SyncGroup[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SyncGroup, index: number, array: SyncGroup[]): boolean
        • Parameters

          • value: SyncGroup
          • index: number
          • array: SyncGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SyncGroup[]
  • splice(start: number, deleteCount: number, ...items: SyncGroup[]): SyncGroup[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SyncGroup[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SyncGroup[]

      Elements to insert into the array in place of the deleted elements.

    Returns SyncGroup[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SyncGroup[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SyncGroup[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SyncGroup>
  • Returns an iterable of values in the array

    Returns IterableIterator<SyncGroup>

type

type: object

className

className: string = "SyncGroupListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SyncGroup"

name

name: "Composite" = "Composite"

Const SyncGroupLogListResult

SyncGroupLogListResult: object
interface

A list of sync group log properties.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncGroupLogListResult"

__@iterator

  • __@iterator(): IterableIterator<SyncGroupLogProperties>
  • Iterator

    Returns IterableIterator<SyncGroupLogProperties>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SyncGroupLogProperties>[]): SyncGroupLogProperties[]
  • concat(...items: (T | ConcatArray<T>)[]): SyncGroupLogProperties[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SyncGroupLogProperties>[]

      Additional items to add to the end of array1.

    Returns SyncGroupLogProperties[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SyncGroupLogProperties[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SyncGroupLogProperties]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SyncGroupLogProperties]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SyncGroupLogProperties, index: number, array: SyncGroupLogProperties[]): boolean
        • Parameters

          • value: SyncGroupLogProperties
          • index: number
          • array: SyncGroupLogProperties[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SyncGroupLogProperties, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SyncGroupLogProperties

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SyncGroupLogProperties[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SyncGroupLogProperties

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncGroupLogProperties, index: number, array: SyncGroupLogProperties[]): boolean
        • Parameters

          • value: SyncGroupLogProperties
          • index: number
          • array: SyncGroupLogProperties[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncGroupLogProperties, index: number, array: SyncGroupLogProperties[]): any
        • Parameters

          • value: SyncGroupLogProperties
          • index: number
          • array: SyncGroupLogProperties[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SyncGroupLogProperties[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SyncGroupLogProperties | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SyncGroupLogProperties

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SyncGroupLogProperties, index: number, obj: SyncGroupLogProperties[]): boolean
        • Parameters

          • this: void
          • value: SyncGroupLogProperties
          • index: number
          • obj: SyncGroupLogProperties[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SyncGroupLogProperties, index: number, obj: SyncGroupLogProperties[]): boolean
        • Parameters

          • value: SyncGroupLogProperties
          • index: number
          • obj: SyncGroupLogProperties[]

          Returns boolean

    • Optional thisArg: any

    Returns SyncGroupLogProperties | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SyncGroupLogProperties, index: number, obj: SyncGroupLogProperties[]): boolean
        • Parameters

          • value: SyncGroupLogProperties
          • index: number
          • obj: SyncGroupLogProperties[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SyncGroupLogProperties, index: number, array: SyncGroupLogProperties[]): void
        • Parameters

          • value: SyncGroupLogProperties
          • index: number
          • array: SyncGroupLogProperties[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SyncGroupLogProperties, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SyncGroupLogProperties

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SyncGroupLogProperties, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SyncGroupLogProperties

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SyncGroupLogProperties, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SyncGroupLogProperties

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SyncGroupLogProperties, index: number, array: SyncGroupLogProperties[]): U
        • Parameters

          • value: SyncGroupLogProperties
          • index: number
          • array: SyncGroupLogProperties[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SyncGroupLogProperties | undefined
  • Removes the last element from an array and returns it.

    Returns SyncGroupLogProperties | undefined

push

  • push(...items: SyncGroupLogProperties[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SyncGroupLogProperties[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SyncGroupLogProperties
  • reduce(callbackfn: function, initialValue: SyncGroupLogProperties): SyncGroupLogProperties
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncGroupLogProperties, currentValue: SyncGroupLogProperties, currentIndex: number, array: SyncGroupLogProperties[]): SyncGroupLogProperties
        • Parameters

          • previousValue: SyncGroupLogProperties
          • currentValue: SyncGroupLogProperties
          • currentIndex: number
          • array: SyncGroupLogProperties[]

          Returns SyncGroupLogProperties

    Returns SyncGroupLogProperties

  • Parameters

    • callbackfn: function
        • (previousValue: SyncGroupLogProperties, currentValue: SyncGroupLogProperties, currentIndex: number, array: SyncGroupLogProperties[]): SyncGroupLogProperties
        • Parameters

          • previousValue: SyncGroupLogProperties
          • currentValue: SyncGroupLogProperties
          • currentIndex: number
          • array: SyncGroupLogProperties[]

          Returns SyncGroupLogProperties

    • initialValue: SyncGroupLogProperties

    Returns SyncGroupLogProperties

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncGroupLogProperties, currentIndex: number, array: SyncGroupLogProperties[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncGroupLogProperties
          • currentIndex: number
          • array: SyncGroupLogProperties[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SyncGroupLogProperties
  • reduceRight(callbackfn: function, initialValue: SyncGroupLogProperties): SyncGroupLogProperties
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncGroupLogProperties, currentValue: SyncGroupLogProperties, currentIndex: number, array: SyncGroupLogProperties[]): SyncGroupLogProperties
        • Parameters

          • previousValue: SyncGroupLogProperties
          • currentValue: SyncGroupLogProperties
          • currentIndex: number
          • array: SyncGroupLogProperties[]

          Returns SyncGroupLogProperties

    Returns SyncGroupLogProperties

  • Parameters

    • callbackfn: function
        • (previousValue: SyncGroupLogProperties, currentValue: SyncGroupLogProperties, currentIndex: number, array: SyncGroupLogProperties[]): SyncGroupLogProperties
        • Parameters

          • previousValue: SyncGroupLogProperties
          • currentValue: SyncGroupLogProperties
          • currentIndex: number
          • array: SyncGroupLogProperties[]

          Returns SyncGroupLogProperties

    • initialValue: SyncGroupLogProperties

    Returns SyncGroupLogProperties

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncGroupLogProperties, currentIndex: number, array: SyncGroupLogProperties[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncGroupLogProperties
          • currentIndex: number
          • array: SyncGroupLogProperties[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SyncGroupLogProperties[]
  • Reverses the elements in an Array.

    Returns SyncGroupLogProperties[]

shift

  • shift(): SyncGroupLogProperties | undefined
  • Removes the first element from an array and returns it.

    Returns SyncGroupLogProperties | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SyncGroupLogProperties[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SyncGroupLogProperties[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SyncGroupLogProperties, index: number, array: SyncGroupLogProperties[]): boolean
        • Parameters

          • value: SyncGroupLogProperties
          • index: number
          • array: SyncGroupLogProperties[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SyncGroupLogProperties[]
  • splice(start: number, deleteCount: number, ...items: SyncGroupLogProperties[]): SyncGroupLogProperties[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SyncGroupLogProperties[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SyncGroupLogProperties[]

      Elements to insert into the array in place of the deleted elements.

    Returns SyncGroupLogProperties[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SyncGroupLogProperties[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SyncGroupLogProperties[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SyncGroupLogProperties>
  • Returns an iterable of values in the array

    Returns IterableIterator<SyncGroupLogProperties>

type

type: object

className

className: string = "SyncGroupLogListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SyncGroupLogProperties"

name

name: "Composite" = "Composite"

Const SyncGroupLogProperties

SyncGroupLogProperties: object

Properties of an Azure SQL Database sync group log.

Optional details

details: undefined | string

Details of the sync group log. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationStatus

operationStatus: undefined | string

OperationStatus of the sync group log. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncGroupLogProperties"

Optional source

source: undefined | string

Source of the sync group log. NOTE: This property will not be serialized. It can only be populated by the server.

Optional timestamp

timestamp: Date

Timestamp of the sync group log. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tracingId

tracingId: undefined | string

TracingId of the sync group log. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

Type of the sync group log. Possible values include: 'All', 'Error', 'Warning', 'Success' NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "SyncGroupLogProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

details

details: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "details"

type

type: object

name

name: "String" = "String"

operationStatus

operationStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "operationStatus"

type

type: object

name

name: "String" = "String"

source

source: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "source"

type

type: object

name

name: "String" = "String"

timestamp

timestamp: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "timestamp"

type

type: object

name

name: "DateTime" = "DateTime"

tracingId

tracingId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tracingId"

type

type: object

name

name: "Uuid" = "Uuid"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const SyncGroupSchema

SyncGroupSchema: object

Properties of sync group schema.

Optional masterSyncMemberName

masterSyncMemberName: undefined | string

Name of master sync member where the schema is from.

serializedName

serializedName: string = "SyncGroupSchema"

Optional tables

tables: SyncGroupSchemaTable[]

List of tables in sync group schema.

type

type: object

className

className: string = "SyncGroupSchema"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

masterSyncMemberName

masterSyncMemberName: object

serializedName

serializedName: string = "masterSyncMemberName"

type

type: object

name

name: "String" = "String"

tables

tables: object

serializedName

serializedName: string = "tables"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SyncGroupSchemaTable"

name

name: "Composite" = "Composite"

Const SyncGroupSchemaTable

SyncGroupSchemaTable: object

Properties of table in sync group schema.

Optional columns

columns: SyncGroupSchemaTableColumn[]

List of columns in sync group schema.

Optional quotedName

quotedName: undefined | string

Quoted name of sync group schema table.

serializedName

serializedName: string = "SyncGroupSchemaTable"

type

type: object

className

className: string = "SyncGroupSchemaTable"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

columns

columns: object

serializedName

serializedName: string = "columns"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SyncGroupSchemaTableColumn"

name

name: "Composite" = "Composite"

quotedName

quotedName: object

serializedName

serializedName: string = "quotedName"

type

type: object

name

name: "String" = "String"

Const SyncGroupSchemaTableColumn

SyncGroupSchemaTableColumn: object

Properties of column in sync group table.

Optional dataSize

dataSize: undefined | string

Data size of the column.

Optional dataType

dataType: undefined | string

Data type of the column.

Optional quotedName

quotedName: undefined | string

Quoted name of sync group table column.

serializedName

serializedName: string = "SyncGroupSchemaTableColumn"

type

type: object

className

className: string = "SyncGroupSchemaTableColumn"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dataSize

dataSize: object

serializedName

serializedName: string = "dataSize"

type

type: object

name

name: "String" = "String"

dataType

dataType: object

serializedName

serializedName: string = "dataType"

type

type: object

name

name: "String" = "String"

quotedName

quotedName: object

serializedName

serializedName: string = "quotedName"

type

type: object

name

name: "String" = "String"

Const SyncMember

SyncMember: object

An Azure SQL Database sync member.

Optional databaseName

databaseName: undefined | string

Database name of the member database in the sync member.

Optional databaseType

databaseType: SyncMemberDbType

Database type of the sync member. Possible values include: 'AzureSqlDatabase', 'SqlServerDatabase'

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional password

password: undefined | string

Password of the member database in the sync member.

serializedName

serializedName: string = "SyncMember"

Optional serverName

serverName: undefined | string

Server name of the member database in the sync member

Optional sqlServerDatabaseId

sqlServerDatabaseId: undefined | string

SQL Server database id of the sync member.

Optional syncAgentId

syncAgentId: undefined | string

ARM resource id of the sync agent in the sync member.

Optional syncDirection

syncDirection: SyncDirection

Sync direction of the sync member. Possible values include: 'Bidirectional', 'OneWayMemberToHub', 'OneWayHubToMember'

Optional syncState

syncState: SyncMemberState

Sync state of the sync member. Possible values include: 'SyncInProgress', 'SyncSucceeded', 'SyncFailed', 'DisabledTombstoneCleanup', 'DisabledBackupRestore', 'SyncSucceededWithWarnings', 'SyncCancelling', 'SyncCancelled', 'UnProvisioned', 'Provisioning', 'Provisioned', 'ProvisionFailed', 'DeProvisioning', 'DeProvisioned', 'DeProvisionFailed', 'Reprovisioning', 'ReprovisionFailed', 'UnReprovisioned' NOTE: This property will not be serialized. It can only be populated by the server.

Optional userName

userName: undefined | string

User name of the member database in the sync member.

type

type: object

className

className: string = "SyncMember"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

databaseName

databaseName: object

serializedName

serializedName: string = "properties.databaseName"

type

type: object

name

name: "String" = "String"

databaseType

databaseType: object

serializedName

serializedName: string = "properties.databaseType"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

serverName

serverName: object

serializedName

serializedName: string = "properties.serverName"

type

type: object

name

name: "String" = "String"

sqlServerDatabaseId

sqlServerDatabaseId: object

serializedName

serializedName: string = "properties.sqlServerDatabaseId"

type

type: object

name

name: "Uuid" = "Uuid"

syncAgentId

syncAgentId: object

serializedName

serializedName: string = "properties.syncAgentId"

type

type: object

name

name: "String" = "String"

syncDirection

syncDirection: object

serializedName

serializedName: string = "properties.syncDirection"

type

type: object

name

name: "String" = "String"

syncState

syncState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.syncState"

type

type: object

name

name: "String" = "String"

userName

userName: object

serializedName

serializedName: string = "properties.userName"

type

type: object

name

name: "String" = "String"

Const SyncMemberListResult

SyncMemberListResult: object
interface

A list of Azure SQL Database sync members.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SyncMemberListResult"

__@iterator

  • __@iterator(): IterableIterator<SyncMember>
  • Iterator

    Returns IterableIterator<SyncMember>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SyncMember>[]): SyncMember[]
  • concat(...items: (T | ConcatArray<T>)[]): SyncMember[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SyncMember>[]

      Additional items to add to the end of array1.

    Returns SyncMember[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SyncMember[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SyncMember]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SyncMember]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SyncMember, index: number, array: SyncMember[]): boolean
        • Parameters

          • value: SyncMember
          • index: number
          • array: SyncMember[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SyncMember, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SyncMember

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SyncMember[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SyncMember

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncMember, index: number, array: SyncMember[]): boolean
        • Parameters

          • value: SyncMember
          • index: number
          • array: SyncMember[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SyncMember, index: number, array: SyncMember[]): any
        • Parameters

          • value: SyncMember
          • index: number
          • array: SyncMember[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SyncMember[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SyncMember | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SyncMember

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SyncMember, index: number, obj: SyncMember[]): boolean
        • Parameters

          • this: void
          • value: SyncMember
          • index: number
          • obj: SyncMember[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SyncMember, index: number, obj: SyncMember[]): boolean
        • Parameters

          • value: SyncMember
          • index: number
          • obj: SyncMember[]

          Returns boolean

    • Optional thisArg: any

    Returns SyncMember | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SyncMember, index: number, obj: SyncMember[]): boolean
        • Parameters

          • value: SyncMember
          • index: number
          • obj: SyncMember[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SyncMember, index: number, array: SyncMember[]): void
        • Parameters

          • value: SyncMember
          • index: number
          • array: SyncMember[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SyncMember, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SyncMember

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SyncMember, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SyncMember

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SyncMember, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SyncMember

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SyncMember, index: number, array: SyncMember[]): U
        • Parameters

          • value: SyncMember
          • index: number
          • array: SyncMember[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SyncMember | undefined
  • Removes the last element from an array and returns it.

    Returns SyncMember | undefined

push

  • push(...items: SyncMember[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SyncMember[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SyncMember
  • reduce(callbackfn: function, initialValue: SyncMember): SyncMember
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncMember, currentValue: SyncMember, currentIndex: number, array: SyncMember[]): SyncMember
        • Parameters

          • previousValue: SyncMember
          • currentValue: SyncMember
          • currentIndex: number
          • array: SyncMember[]

          Returns SyncMember

    Returns SyncMember

  • Parameters

    • callbackfn: function
        • (previousValue: SyncMember, currentValue: SyncMember, currentIndex: number, array: SyncMember[]): SyncMember
        • Parameters

          • previousValue: SyncMember
          • currentValue: SyncMember
          • currentIndex: number
          • array: SyncMember[]

          Returns SyncMember

    • initialValue: SyncMember

    Returns SyncMember

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncMember, currentIndex: number, array: SyncMember[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncMember
          • currentIndex: number
          • array: SyncMember[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SyncMember
  • reduceRight(callbackfn: function, initialValue: SyncMember): SyncMember
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SyncMember, currentValue: SyncMember, currentIndex: number, array: SyncMember[]): SyncMember
        • Parameters

          • previousValue: SyncMember
          • currentValue: SyncMember
          • currentIndex: number
          • array: SyncMember[]

          Returns SyncMember

    Returns SyncMember

  • Parameters

    • callbackfn: function
        • (previousValue: SyncMember, currentValue: SyncMember, currentIndex: number, array: SyncMember[]): SyncMember
        • Parameters

          • previousValue: SyncMember
          • currentValue: SyncMember
          • currentIndex: number
          • array: SyncMember[]

          Returns SyncMember

    • initialValue: SyncMember

    Returns SyncMember

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SyncMember, currentIndex: number, array: SyncMember[]): U
        • Parameters

          • previousValue: U
          • currentValue: SyncMember
          • currentIndex: number
          • array: SyncMember[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SyncMember[]
  • Reverses the elements in an Array.

    Returns SyncMember[]

shift

  • shift(): SyncMember | undefined
  • Removes the first element from an array and returns it.

    Returns SyncMember | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SyncMember[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SyncMember[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SyncMember, index: number, array: SyncMember[]): boolean
        • Parameters

          • value: SyncMember
          • index: number
          • array: SyncMember[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SyncMember[]
  • splice(start: number, deleteCount: number, ...items: SyncMember[]): SyncMember[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SyncMember[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SyncMember[]

      Elements to insert into the array in place of the deleted elements.

    Returns SyncMember[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SyncMember[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SyncMember[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SyncMember>
  • Returns an iterable of values in the array

    Returns IterableIterator<SyncMember>

type

type: object

className

className: string = "SyncMemberListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SyncMember"

name

name: "Composite" = "Composite"

Const TdeCertificate

TdeCertificate: object

A TDE certificate that can be uploaded into a server.

Optional certPassword

certPassword: undefined | string

The certificate password.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

privateBlob

privateBlob: string

The base64 encoded certificate private blob.

serializedName

serializedName: string = "TdeCertificate"

type

type: object

className

className: string = "TdeCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

certPassword

certPassword: object

serializedName

serializedName: string = "properties.certPassword"

type

type: object

name

name: "String" = "String"

privateBlob

privateBlob: object

required

required: true = true

serializedName

serializedName: string = "properties.privateBlob"

type

type: object

name

name: "String" = "String"

Const TrackedResource

TrackedResource: object

ARM tracked top level resource.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TrackedResource"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "TrackedResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

required

required: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const TransparentDataEncryption

TransparentDataEncryption: object

Represents a database transparent data encryption configuration.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

Resource location. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TransparentDataEncryption"

Optional status

The status of the database transparent data encryption. Possible values include: 'Enabled', 'Disabled'

type

type: object

className

className: string = "TransparentDataEncryption"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

Const TransparentDataEncryptionActivity

TransparentDataEncryptionActivity: object

Represents a database transparent data encryption Scan.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

Resource location. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional percentComplete

percentComplete: undefined | number

The percent complete of the transparent data encryption scan for a database. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TransparentDataEncryptionActivity"

Optional status

The status of the database. Possible values include: 'Encrypting', 'Decrypting' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "TransparentDataEncryptionActivity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

percentComplete

percentComplete: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.percentComplete"

type

type: object

name

name: "Number" = "Number"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

Const TransparentDataEncryptionActivityListResult

TransparentDataEncryptionActivityListResult: object
interface

Represents the response to a list database transparent data encryption activity request.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "TransparentDataEncryptionActivityListResult"

__@iterator

  • __@iterator(): IterableIterator<TransparentDataEncryptionActivity>
  • Iterator

    Returns IterableIterator<TransparentDataEncryptionActivity>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<TransparentDataEncryptionActivity>[]): TransparentDataEncryptionActivity[]
  • concat(...items: (T | ConcatArray<T>)[]): TransparentDataEncryptionActivity[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<TransparentDataEncryptionActivity>[]

      Additional items to add to the end of array1.

    Returns TransparentDataEncryptionActivity[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns TransparentDataEncryptionActivity[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, TransparentDataEncryptionActivity]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, TransparentDataEncryptionActivity]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: TransparentDataEncryptionActivity, index: number, array: TransparentDataEncryptionActivity[]): boolean
        • Parameters

          • value: TransparentDataEncryptionActivity
          • index: number
          • array: TransparentDataEncryptionActivity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: TransparentDataEncryptionActivity, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: TransparentDataEncryptionActivity

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): TransparentDataEncryptionActivity[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: TransparentDataEncryptionActivity

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: TransparentDataEncryptionActivity, index: number, array: TransparentDataEncryptionActivity[]): boolean
        • Parameters

          • value: TransparentDataEncryptionActivity
          • index: number
          • array: TransparentDataEncryptionActivity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: TransparentDataEncryptionActivity, index: number, array: TransparentDataEncryptionActivity[]): any
        • Parameters

          • value: TransparentDataEncryptionActivity
          • index: number
          • array: TransparentDataEncryptionActivity[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns TransparentDataEncryptionActivity[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): TransparentDataEncryptionActivity | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: TransparentDataEncryptionActivity

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: TransparentDataEncryptionActivity, index: number, obj: TransparentDataEncryptionActivity[]): boolean
        • Parameters

          • this: void
          • value: TransparentDataEncryptionActivity
          • index: number
          • obj: TransparentDataEncryptionActivity[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: TransparentDataEncryptionActivity, index: number, obj: TransparentDataEncryptionActivity[]): boolean
        • Parameters

          • value: TransparentDataEncryptionActivity
          • index: number
          • obj: TransparentDataEncryptionActivity[]

          Returns boolean

    • Optional thisArg: any

    Returns TransparentDataEncryptionActivity | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: TransparentDataEncryptionActivity, index: number, obj: TransparentDataEncryptionActivity[]): boolean
        • Parameters

          • value: TransparentDataEncryptionActivity
          • index: number
          • obj: TransparentDataEncryptionActivity[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: TransparentDataEncryptionActivity, index: number, array: TransparentDataEncryptionActivity[]): void
        • Parameters

          • value: TransparentDataEncryptionActivity
          • index: number
          • array: TransparentDataEncryptionActivity[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: TransparentDataEncryptionActivity, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: TransparentDataEncryptionActivity

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: TransparentDataEncryptionActivity, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: TransparentDataEncryptionActivity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: TransparentDataEncryptionActivity, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: TransparentDataEncryptionActivity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: TransparentDataEncryptionActivity, index: number, array: TransparentDataEncryptionActivity[]): U
        • Parameters

          • value: TransparentDataEncryptionActivity
          • index: number
          • array: TransparentDataEncryptionActivity[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): TransparentDataEncryptionActivity | undefined
  • Removes the last element from an array and returns it.

    Returns TransparentDataEncryptionActivity | undefined

push

  • push(...items: TransparentDataEncryptionActivity[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: TransparentDataEncryptionActivity[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): TransparentDataEncryptionActivity
  • reduce(callbackfn: function, initialValue: TransparentDataEncryptionActivity): TransparentDataEncryptionActivity
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: TransparentDataEncryptionActivity, currentValue: TransparentDataEncryptionActivity, currentIndex: number, array: TransparentDataEncryptionActivity[]): TransparentDataEncryptionActivity
        • Parameters

          • previousValue: TransparentDataEncryptionActivity
          • currentValue: TransparentDataEncryptionActivity
          • currentIndex: number
          • array: TransparentDataEncryptionActivity[]

          Returns TransparentDataEncryptionActivity

    Returns TransparentDataEncryptionActivity

  • Parameters

    • callbackfn: function
        • (previousValue: TransparentDataEncryptionActivity, currentValue: TransparentDataEncryptionActivity, currentIndex: number, array: TransparentDataEncryptionActivity[]): TransparentDataEncryptionActivity
        • Parameters

          • previousValue: TransparentDataEncryptionActivity
          • currentValue: TransparentDataEncryptionActivity
          • currentIndex: number
          • array: TransparentDataEncryptionActivity[]

          Returns TransparentDataEncryptionActivity

    • initialValue: TransparentDataEncryptionActivity

    Returns TransparentDataEncryptionActivity

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: TransparentDataEncryptionActivity, currentIndex: number, array: TransparentDataEncryptionActivity[]): U
        • Parameters

          • previousValue: U
          • currentValue: TransparentDataEncryptionActivity
          • currentIndex: number
          • array: TransparentDataEncryptionActivity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): TransparentDataEncryptionActivity
  • reduceRight(callbackfn: function, initialValue: TransparentDataEncryptionActivity): TransparentDataEncryptionActivity
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: TransparentDataEncryptionActivity, currentValue: TransparentDataEncryptionActivity, currentIndex: number, array: TransparentDataEncryptionActivity[]): TransparentDataEncryptionActivity
        • Parameters

          • previousValue: TransparentDataEncryptionActivity
          • currentValue: TransparentDataEncryptionActivity
          • currentIndex: number
          • array: TransparentDataEncryptionActivity[]

          Returns TransparentDataEncryptionActivity

    Returns TransparentDataEncryptionActivity

  • Parameters

    • callbackfn: function
        • (previousValue: TransparentDataEncryptionActivity, currentValue: TransparentDataEncryptionActivity, currentIndex: number, array: TransparentDataEncryptionActivity[]): TransparentDataEncryptionActivity
        • Parameters

          • previousValue: TransparentDataEncryptionActivity
          • currentValue: TransparentDataEncryptionActivity
          • currentIndex: number
          • array: TransparentDataEncryptionActivity[]

          Returns TransparentDataEncryptionActivity

    • initialValue: TransparentDataEncryptionActivity

    Returns TransparentDataEncryptionActivity

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: TransparentDataEncryptionActivity, currentIndex: number, array: TransparentDataEncryptionActivity[]): U
        • Parameters

          • previousValue: U
          • currentValue: TransparentDataEncryptionActivity
          • currentIndex: number
          • array: TransparentDataEncryptionActivity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): TransparentDataEncryptionActivity[]
  • Reverses the elements in an Array.

    Returns TransparentDataEncryptionActivity[]

shift

  • shift(): TransparentDataEncryptionActivity | undefined
  • Removes the first element from an array and returns it.

    Returns TransparentDataEncryptionActivity | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): TransparentDataEncryptionActivity[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns TransparentDataEncryptionActivity[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: TransparentDataEncryptionActivity, index: number, array: TransparentDataEncryptionActivity[]): boolean
        • Parameters

          • value: TransparentDataEncryptionActivity
          • index: number
          • array: TransparentDataEncryptionActivity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): TransparentDataEncryptionActivity[]
  • splice(start: number, deleteCount: number, ...items: TransparentDataEncryptionActivity[]): TransparentDataEncryptionActivity[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns TransparentDataEncryptionActivity[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: TransparentDataEncryptionActivity[]

      Elements to insert into the array in place of the deleted elements.

    Returns TransparentDataEncryptionActivity[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: TransparentDataEncryptionActivity[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: TransparentDataEncryptionActivity[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<TransparentDataEncryptionActivity>
  • Returns an iterable of values in the array

    Returns IterableIterator<TransparentDataEncryptionActivity>

type

type: object

className

className: string = "TransparentDataEncryptionActivityListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TransparentDataEncryptionActivity"

name

name: "Composite" = "Composite"

Const VirtualCluster

VirtualCluster: object

An Azure SQL virtual cluster.

Optional childResources

childResources: string[]

List of resources in this virtual cluster. NOTE: This property will not be serialized. It can only be populated by the server.

Optional family

family: undefined | string

If the service has different generations of hardware, for the same SKU, then that can be captured here.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualCluster"

Optional subnetId

subnetId: undefined | string

Subnet resource ID for the virtual cluster. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "VirtualCluster"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

childResources

childResources: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.childResources"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

family

family: object

serializedName

serializedName: string = "properties.family"

type

type: object

name

name: "String" = "String"

subnetId

subnetId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subnetId"

type

type: object

name

name: "String" = "String"

Const VirtualClusterListResult

VirtualClusterListResult: object
interface

A list of virtual clusters.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualClusterListResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualCluster>
  • Iterator

    Returns IterableIterator<VirtualCluster>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualCluster>[]): VirtualCluster[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualCluster[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualCluster>[]

      Additional items to add to the end of array1.

    Returns VirtualCluster[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualCluster[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualCluster]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualCluster]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualCluster, index: number, array: VirtualCluster[]): boolean
        • Parameters

          • value: VirtualCluster
          • index: number
          • array: VirtualCluster[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualCluster, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualCluster

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualCluster[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualCluster

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualCluster, index: number, array: VirtualCluster[]): boolean
        • Parameters

          • value: VirtualCluster
          • index: number
          • array: VirtualCluster[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualCluster, index: number, array: VirtualCluster[]): any
        • Parameters

          • value: VirtualCluster
          • index: number
          • array: VirtualCluster[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualCluster[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualCluster | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualCluster

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualCluster, index: number, obj: VirtualCluster[]): boolean
        • Parameters

          • this: void
          • value: VirtualCluster
          • index: number
          • obj: VirtualCluster[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualCluster, index: number, obj: VirtualCluster[]): boolean
        • Parameters

          • value: VirtualCluster
          • index: number
          • obj: VirtualCluster[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualCluster | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualCluster, index: number, obj: VirtualCluster[]): boolean
        • Parameters

          • value: VirtualCluster
          • index: number
          • obj: VirtualCluster[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualCluster, index: number, array: VirtualCluster[]): void
        • Parameters

          • value: VirtualCluster
          • index: number
          • array: VirtualCluster[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualCluster, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualCluster

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualCluster, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualCluster

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualCluster, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualCluster

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualCluster, index: number, array: VirtualCluster[]): U
        • Parameters

          • value: VirtualCluster
          • index: number
          • array: VirtualCluster[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualCluster | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualCluster | undefined

push

  • push(...items: VirtualCluster[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualCluster[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualCluster
  • reduce(callbackfn: function, initialValue: VirtualCluster): VirtualCluster
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualCluster, currentValue: VirtualCluster, currentIndex: number, array: VirtualCluster[]): VirtualCluster
        • Parameters

          • previousValue: VirtualCluster
          • currentValue: VirtualCluster
          • currentIndex: number
          • array: VirtualCluster[]

          Returns VirtualCluster

    Returns VirtualCluster

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualCluster, currentValue: VirtualCluster, currentIndex: number, array: VirtualCluster[]): VirtualCluster
        • Parameters

          • previousValue: VirtualCluster
          • currentValue: VirtualCluster
          • currentIndex: number
          • array: VirtualCluster[]

          Returns VirtualCluster

    • initialValue: VirtualCluster

    Returns VirtualCluster

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualCluster, currentIndex: number, array: VirtualCluster[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualCluster
          • currentIndex: number
          • array: VirtualCluster[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualCluster
  • reduceRight(callbackfn: function, initialValue: VirtualCluster): VirtualCluster
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualCluster, currentValue: VirtualCluster, currentIndex: number, array: VirtualCluster[]): VirtualCluster
        • Parameters

          • previousValue: VirtualCluster
          • currentValue: VirtualCluster
          • currentIndex: number
          • array: VirtualCluster[]

          Returns VirtualCluster

    Returns VirtualCluster

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualCluster, currentValue: VirtualCluster, currentIndex: number, array: VirtualCluster[]): VirtualCluster
        • Parameters

          • previousValue: VirtualCluster
          • currentValue: VirtualCluster
          • currentIndex: number
          • array: VirtualCluster[]

          Returns VirtualCluster

    • initialValue: VirtualCluster

    Returns VirtualCluster

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualCluster, currentIndex: number, array: VirtualCluster[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualCluster
          • currentIndex: number
          • array: VirtualCluster[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualCluster[]
  • Reverses the elements in an Array.

    Returns VirtualCluster[]

shift

  • shift(): VirtualCluster | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualCluster | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualCluster[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualCluster[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualCluster, index: number, array: VirtualCluster[]): boolean
        • Parameters

          • value: VirtualCluster
          • index: number
          • array: VirtualCluster[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualCluster[]
  • splice(start: number, deleteCount: number, ...items: VirtualCluster[]): VirtualCluster[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualCluster[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualCluster[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualCluster[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualCluster[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualCluster[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualCluster>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualCluster>

type

type: object

className

className: string = "VirtualClusterListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualCluster"

name

name: "Composite" = "Composite"

Const VirtualClusterUpdate

VirtualClusterUpdate: object

An update request for an Azure SQL Database virtual cluster.

Optional childResources

childResources: string[]

List of resources in this virtual cluster. NOTE: This property will not be serialized. It can only be populated by the server.

Optional family

family: undefined | string

If the service has different generations of hardware, for the same SKU, then that can be captured here.

serializedName

serializedName: string = "VirtualClusterUpdate"

Optional subnetId

subnetId: undefined | string

Subnet resource ID for the virtual cluster. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "VirtualClusterUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

childResources

childResources: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.childResources"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

family

family: object

serializedName

serializedName: string = "properties.family"

type

type: object

name

name: "String" = "String"

subnetId

subnetId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subnetId"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const VirtualNetworkRule

VirtualNetworkRule: object

A virtual network rule.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ignoreMissingVnetServiceEndpoint

ignoreMissingVnetServiceEndpoint: undefined | false | true

Create firewall rule before the virtual network has vnet service endpoint enabled.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkRule"

Optional state

Virtual Network Rule State. Possible values include: 'Initializing', 'InProgress', 'Ready', 'Deleting', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

virtualNetworkSubnetId

virtualNetworkSubnetId: string

The ARM resource id of the virtual network subnet.

type

type: object

className

className: string = "VirtualNetworkRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ignoreMissingVnetServiceEndpoint

ignoreMissingVnetServiceEndpoint: object

serializedName

serializedName: string = "properties.ignoreMissingVnetServiceEndpoint"

type

type: object

name

name: "Boolean" = "Boolean"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

virtualNetworkSubnetId

virtualNetworkSubnetId: object

required

required: true = true

serializedName

serializedName: string = "properties.virtualNetworkSubnetId"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkRuleListResult

VirtualNetworkRuleListResult: object
interface

A list of virtual network rules.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkRuleListResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetworkRule>
  • Iterator

    Returns IterableIterator<VirtualNetworkRule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetworkRule>[]): VirtualNetworkRule[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetworkRule[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetworkRule>[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkRule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkRule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetworkRule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetworkRule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetworkRule, index: number, array: VirtualNetworkRule[]): boolean
        • Parameters

          • value: VirtualNetworkRule
          • index: number
          • array: VirtualNetworkRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetworkRule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetworkRule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetworkRule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetworkRule

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkRule, index: number, array: VirtualNetworkRule[]): boolean
        • Parameters

          • value: VirtualNetworkRule
          • index: number
          • array: VirtualNetworkRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkRule, index: number, array: VirtualNetworkRule[]): any
        • Parameters

          • value: VirtualNetworkRule
          • index: number
          • array: VirtualNetworkRule[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetworkRule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetworkRule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetworkRule

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetworkRule, index: number, obj: VirtualNetworkRule[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetworkRule
          • index: number
          • obj: VirtualNetworkRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetworkRule, index: number, obj: VirtualNetworkRule[]): boolean
        • Parameters

          • value: VirtualNetworkRule
          • index: number
          • obj: VirtualNetworkRule[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetworkRule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetworkRule, index: number, obj: VirtualNetworkRule[]): boolean
        • Parameters

          • value: VirtualNetworkRule
          • index: number
          • obj: VirtualNetworkRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkRule, index: number, array: VirtualNetworkRule[]): void
        • Parameters

          • value: VirtualNetworkRule
          • index: number
          • array: VirtualNetworkRule[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetworkRule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetworkRule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetworkRule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetworkRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetworkRule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetworkRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkRule, index: number, array: VirtualNetworkRule[]): U
        • Parameters

          • value: VirtualNetworkRule
          • index: number
          • array: VirtualNetworkRule[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetworkRule | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetworkRule | undefined

push

  • push(...items: VirtualNetworkRule[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetworkRule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetworkRule
  • reduce(callbackfn: function, initialValue: VirtualNetworkRule): VirtualNetworkRule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkRule, currentValue: VirtualNetworkRule, currentIndex: number, array: VirtualNetworkRule[]): VirtualNetworkRule
        • Parameters

          • previousValue: VirtualNetworkRule
          • currentValue: VirtualNetworkRule
          • currentIndex: number
          • array: VirtualNetworkRule[]

          Returns VirtualNetworkRule

    Returns VirtualNetworkRule

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkRule, currentValue: VirtualNetworkRule, currentIndex: number, array: VirtualNetworkRule[]): VirtualNetworkRule
        • Parameters

          • previousValue: VirtualNetworkRule
          • currentValue: VirtualNetworkRule
          • currentIndex: number
          • array: VirtualNetworkRule[]

          Returns VirtualNetworkRule

    • initialValue: VirtualNetworkRule

    Returns VirtualNetworkRule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkRule, currentIndex: number, array: VirtualNetworkRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkRule
          • currentIndex: number
          • array: VirtualNetworkRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetworkRule
  • reduceRight(callbackfn: function, initialValue: VirtualNetworkRule): VirtualNetworkRule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkRule, currentValue: VirtualNetworkRule, currentIndex: number, array: VirtualNetworkRule[]): VirtualNetworkRule
        • Parameters

          • previousValue: VirtualNetworkRule
          • currentValue: VirtualNetworkRule
          • currentIndex: number
          • array: VirtualNetworkRule[]

          Returns VirtualNetworkRule

    Returns VirtualNetworkRule

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkRule, currentValue: VirtualNetworkRule, currentIndex: number, array: VirtualNetworkRule[]): VirtualNetworkRule
        • Parameters

          • previousValue: VirtualNetworkRule
          • currentValue: VirtualNetworkRule
          • currentIndex: number
          • array: VirtualNetworkRule[]

          Returns VirtualNetworkRule

    • initialValue: VirtualNetworkRule

    Returns VirtualNetworkRule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkRule, currentIndex: number, array: VirtualNetworkRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkRule
          • currentIndex: number
          • array: VirtualNetworkRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetworkRule[]
  • Reverses the elements in an Array.

    Returns VirtualNetworkRule[]

shift

  • shift(): VirtualNetworkRule | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetworkRule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetworkRule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetworkRule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetworkRule, index: number, array: VirtualNetworkRule[]): boolean
        • Parameters

          • value: VirtualNetworkRule
          • index: number
          • array: VirtualNetworkRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetworkRule[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetworkRule[]): VirtualNetworkRule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetworkRule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetworkRule[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetworkRule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetworkRule[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetworkRule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetworkRule>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetworkRule>

type

type: object

className

className: string = "VirtualNetworkRuleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkRule"

name

name: "Composite" = "Composite"

Const VulnerabilityAssessmentRecurringScansProperties

VulnerabilityAssessmentRecurringScansProperties: object

Properties of a Vulnerability Assessment recurring scans.

Optional emailSubscriptionAdmins

emailSubscriptionAdmins: undefined | false | true

Specifies that the schedule scan notification will be is sent to the subscription administrators. Default value: true.

Optional emails

emails: string[]

Specifies an array of e-mail addresses to which the scan notification is sent.

Optional isEnabled

isEnabled: undefined | false | true

Recurring scans state.

serializedName

serializedName: string = "VulnerabilityAssessmentRecurringScansProperties"

type

type: object

className

className: string = "VulnerabilityAssessmentRecurringScansProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

emailSubscriptionAdmins

emailSubscriptionAdmins: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "emailSubscriptionAdmins"

type

type: object

name

name: "Boolean" = "Boolean"

emails

emails: object

serializedName

serializedName: string = "emails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

isEnabled

isEnabled: object

serializedName

serializedName: string = "isEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const VulnerabilityAssessmentScanError

VulnerabilityAssessmentScanError: object

Properties of a vulnerability assessment scan error.

Optional code

code: undefined | string

The error code. NOTE: This property will not be serialized. It can only be populated by the server.

Optional message

message: undefined | string

The error message. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VulnerabilityAssessmentScanError"

type

type: object

className

className: string = "VulnerabilityAssessmentScanError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const VulnerabilityAssessmentScanRecord

VulnerabilityAssessmentScanRecord: object

A vulnerability assessment scan record.

Optional endTime

endTime: Date

The scan end time (UTC). NOTE: This property will not be serialized. It can only be populated by the server.

Optional errors

errors: VulnerabilityAssessmentScanError[]

The scan errors. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional numberOfFailedSecurityChecks

numberOfFailedSecurityChecks: undefined | number

The number of failed security checks. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scanId

scanId: undefined | string

The scan ID. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VulnerabilityAssessmentScanRecord"

Optional startTime

startTime: Date

The scan start time (UTC). NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

The scan status. Possible values include: 'Passed', 'Failed', 'FailedToRun', 'InProgress' NOTE: This property will not be serialized. It can only be populated by the server.

Optional storageContainerPath

storageContainerPath: undefined | string

The scan results storage container path. NOTE: This property will not be serialized. It can only be populated by the server.

Optional triggerType

The scan trigger type. Possible values include: 'OnDemand', 'Recurring' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "VulnerabilityAssessmentScanRecord"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

errors

errors: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.errors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VulnerabilityAssessmentScanError"

name

name: "Composite" = "Composite"

numberOfFailedSecurityChecks

numberOfFailedSecurityChecks: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.numberOfFailedSecurityChecks"

type

type: object

name

name: "Number" = "Number"

scanId

scanId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.scanId"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

storageContainerPath

storageContainerPath: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.storageContainerPath"

type

type: object

name

name: "String" = "String"

triggerType

triggerType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.triggerType"

type

type: object

name

name: "String" = "String"

Const VulnerabilityAssessmentScanRecordListResult

VulnerabilityAssessmentScanRecordListResult: object
interface

A list of vulnerability assessment scan records.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to retrieve next page of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VulnerabilityAssessmentScanRecordListResult"

__@iterator

  • __@iterator(): IterableIterator<VulnerabilityAssessmentScanRecord>
  • Iterator

    Returns IterableIterator<VulnerabilityAssessmentScanRecord>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VulnerabilityAssessmentScanRecord>[]): VulnerabilityAssessmentScanRecord[]
  • concat(...items: (T | ConcatArray<T>)[]): VulnerabilityAssessmentScanRecord[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VulnerabilityAssessmentScanRecord>[]

      Additional items to add to the end of array1.

    Returns VulnerabilityAssessmentScanRecord[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VulnerabilityAssessmentScanRecord[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VulnerabilityAssessmentScanRecord]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VulnerabilityAssessmentScanRecord]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VulnerabilityAssessmentScanRecord, index: number, array: VulnerabilityAssessmentScanRecord[]): boolean
        • Parameters

          • value: VulnerabilityAssessmentScanRecord
          • index: number
          • array: VulnerabilityAssessmentScanRecord[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VulnerabilityAssessmentScanRecord, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VulnerabilityAssessmentScanRecord

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VulnerabilityAssessmentScanRecord[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VulnerabilityAssessmentScanRecord

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VulnerabilityAssessmentScanRecord, index: number, array: VulnerabilityAssessmentScanRecord[]): boolean
        • Parameters

          • value: VulnerabilityAssessmentScanRecord
          • index: number
          • array: VulnerabilityAssessmentScanRecord[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VulnerabilityAssessmentScanRecord, index: number, array: VulnerabilityAssessmentScanRecord[]): any
        • Parameters

          • value: VulnerabilityAssessmentScanRecord
          • index: number
          • array: VulnerabilityAssessmentScanRecord[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VulnerabilityAssessmentScanRecord[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VulnerabilityAssessmentScanRecord | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VulnerabilityAssessmentScanRecord

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VulnerabilityAssessmentScanRecord, index: number, obj: VulnerabilityAssessmentScanRecord[]): boolean
        • Parameters

          • this: void
          • value: VulnerabilityAssessmentScanRecord
          • index: number
          • obj: VulnerabilityAssessmentScanRecord[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VulnerabilityAssessmentScanRecord, index: number, obj: VulnerabilityAssessmentScanRecord[]): boolean
        • Parameters

          • value: VulnerabilityAssessmentScanRecord
          • index: number
          • obj: VulnerabilityAssessmentScanRecord[]

          Returns boolean

    • Optional thisArg: any

    Returns VulnerabilityAssessmentScanRecord | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VulnerabilityAssessmentScanRecord, index: number, obj: VulnerabilityAssessmentScanRecord[]): boolean
        • Parameters

          • value: VulnerabilityAssessmentScanRecord
          • index: number
          • obj: VulnerabilityAssessmentScanRecord[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VulnerabilityAssessmentScanRecord, index: number, array: VulnerabilityAssessmentScanRecord[]): void
        • Parameters

          • value: VulnerabilityAssessmentScanRecord
          • index: number
          • array: VulnerabilityAssessmentScanRecord[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VulnerabilityAssessmentScanRecord, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VulnerabilityAssessmentScanRecord

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VulnerabilityAssessmentScanRecord, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VulnerabilityAssessmentScanRecord

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VulnerabilityAssessmentScanRecord, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VulnerabilityAssessmentScanRecord

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VulnerabilityAssessmentScanRecord, index: number, array: VulnerabilityAssessmentScanRecord[]): U
        • Parameters

          • value: VulnerabilityAssessmentScanRecord
          • index: number
          • array: VulnerabilityAssessmentScanRecord[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VulnerabilityAssessmentScanRecord | undefined
  • Removes the last element from an array and returns it.

    Returns VulnerabilityAssessmentScanRecord | undefined

push

  • push(...items: VulnerabilityAssessmentScanRecord[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VulnerabilityAssessmentScanRecord[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VulnerabilityAssessmentScanRecord
  • reduce(callbackfn: function, initialValue: VulnerabilityAssessmentScanRecord): VulnerabilityAssessmentScanRecord
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VulnerabilityAssessmentScanRecord, currentValue: VulnerabilityAssessmentScanRecord, currentIndex: number, array: VulnerabilityAssessmentScanRecord[]): VulnerabilityAssessmentScanRecord
        • Parameters

          • previousValue: VulnerabilityAssessmentScanRecord
          • currentValue: VulnerabilityAssessmentScanRecord
          • currentIndex: number
          • array: VulnerabilityAssessmentScanRecord[]

          Returns VulnerabilityAssessmentScanRecord

    Returns VulnerabilityAssessmentScanRecord

  • Parameters

    • callbackfn: function
        • (previousValue: VulnerabilityAssessmentScanRecord, currentValue: VulnerabilityAssessmentScanRecord, currentIndex: number, array: VulnerabilityAssessmentScanRecord[]): VulnerabilityAssessmentScanRecord
        • Parameters

          • previousValue: VulnerabilityAssessmentScanRecord
          • currentValue: VulnerabilityAssessmentScanRecord
          • currentIndex: number
          • array: VulnerabilityAssessmentScanRecord[]

          Returns VulnerabilityAssessmentScanRecord

    • initialValue: VulnerabilityAssessmentScanRecord

    Returns VulnerabilityAssessmentScanRecord

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VulnerabilityAssessmentScanRecord, currentIndex: number, array: VulnerabilityAssessmentScanRecord[]): U
        • Parameters

          • previousValue: U
          • currentValue: VulnerabilityAssessmentScanRecord
          • currentIndex: number
          • array: VulnerabilityAssessmentScanRecord[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VulnerabilityAssessmentScanRecord
  • reduceRight(callbackfn: function, initialValue: VulnerabilityAssessmentScanRecord): VulnerabilityAssessmentScanRecord
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VulnerabilityAssessmentScanRecord, currentValue: VulnerabilityAssessmentScanRecord, currentIndex: number, array: VulnerabilityAssessmentScanRecord[]): VulnerabilityAssessmentScanRecord
        • Parameters

          • previousValue: VulnerabilityAssessmentScanRecord
          • currentValue: VulnerabilityAssessmentScanRecord
          • currentIndex: number
          • array: VulnerabilityAssessmentScanRecord[]

          Returns VulnerabilityAssessmentScanRecord

    Returns VulnerabilityAssessmentScanRecord

  • Parameters

    • callbackfn: function
        • (previousValue: VulnerabilityAssessmentScanRecord, currentValue: VulnerabilityAssessmentScanRecord, currentIndex: number, array: VulnerabilityAssessmentScanRecord[]): VulnerabilityAssessmentScanRecord
        • Parameters

          • previousValue: VulnerabilityAssessmentScanRecord
          • currentValue: VulnerabilityAssessmentScanRecord
          • currentIndex: number
          • array: VulnerabilityAssessmentScanRecord[]

          Returns VulnerabilityAssessmentScanRecord

    • initialValue: VulnerabilityAssessmentScanRecord

    Returns VulnerabilityAssessmentScanRecord

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VulnerabilityAssessmentScanRecord, currentIndex: number, array: VulnerabilityAssessmentScanRecord[]): U
        • Parameters

          • previousValue: U
          • currentValue: VulnerabilityAssessmentScanRecord
          • currentIndex: number
          • array: VulnerabilityAssessmentScanRecord[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VulnerabilityAssessmentScanRecord[]
  • Reverses the elements in an Array.

    Returns VulnerabilityAssessmentScanRecord[]

shift

  • shift(): VulnerabilityAssessmentScanRecord | undefined
  • Removes the first element from an array and returns it.

    Returns VulnerabilityAssessmentScanRecord | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VulnerabilityAssessmentScanRecord[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VulnerabilityAssessmentScanRecord[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VulnerabilityAssessmentScanRecord, index: number, array: VulnerabilityAssessmentScanRecord[]): boolean
        • Parameters

          • value: VulnerabilityAssessmentScanRecord
          • index: number
          • array: VulnerabilityAssessmentScanRecord[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VulnerabilityAssessmentScanRecord[]
  • splice(start: number, deleteCount: number, ...items: VulnerabilityAssessmentScanRecord[]): VulnerabilityAssessmentScanRecord[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VulnerabilityAssessmentScanRecord[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VulnerabilityAssessmentScanRecord[]

      Elements to insert into the array in place of the deleted elements.

    Returns VulnerabilityAssessmentScanRecord[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VulnerabilityAssessmentScanRecord[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VulnerabilityAssessmentScanRecord[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VulnerabilityAssessmentScanRecord>
  • Returns an iterable of values in the array

    Returns IterableIterator<VulnerabilityAssessmentScanRecord>

type

type: object

className

className: string = "VulnerabilityAssessmentScanRecordListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VulnerabilityAssessmentScanRecord"

name

name: "Composite" = "Composite"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const administratorName

administratorName: object

parameterPath

parameterPath: string = "administratorName"

mapper

mapper: object

defaultValue

defaultValue: string = "activeDirectory"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "administratorName"

type

type: object

name

name: "String" = "String"

Const apiVersion0

apiVersion0: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2014-04-01"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion1

apiVersion1: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2015-05-01-preview"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion2

apiVersion2: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2017-10-01-preview"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion3

apiVersion3: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2017-03-01-preview"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion4

apiVersion4: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2018-06-01-preview"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const backupName

backupName: object

parameterPath

parameterPath: string = "backupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "backupName"

type

type: object

name

name: "String" = "String"

Const baselineName

baselineName: object

parameterPath

parameterPath: string = "baselineName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "baselineName"

type

type: object

allowedValues

allowedValues: string[] = ["master","default"]

name

name: "Enum" = "Enum"

Const blobAuditingPolicyName

blobAuditingPolicyName: object

parameterPath

parameterPath: string = "blobAuditingPolicyName"

mapper

mapper: object

defaultValue

defaultValue: string = "default"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "blobAuditingPolicyName"

type

type: object

name

name: "String" = "String"

Const columnName

columnName: object

parameterPath

parameterPath: string = "columnName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "columnName"

type

type: object

name

name: "String" = "String"

Const communicationLinkName

communicationLinkName: object

parameterPath

parameterPath: string = "communicationLinkName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "communicationLinkName"

type

type: object

name

name: "String" = "String"

Const connectionPolicyName

connectionPolicyName: object

parameterPath

parameterPath: string = "connectionPolicyName"

mapper

mapper: object

defaultValue

defaultValue: string = "default"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "connectionPolicyName"

type

type: object

name

name: "String" = "String"

Const continuationToken

continuationToken: object

parameterPath

parameterPath: string[] = ["options","continuationToken"]

mapper

mapper: object

serializedName

serializedName: string = "continuationToken"

type

type: object

name

name: "String" = "String"

Const createTimeMax

createTimeMax: object

parameterPath

parameterPath: string[] = ["options","createTimeMax"]

mapper

mapper: object

serializedName

serializedName: string = "createTimeMax"

type

type: object

name

name: "DateTime" = "DateTime"

Const createTimeMin

createTimeMin: object

parameterPath

parameterPath: string[] = ["options","createTimeMin"]

mapper

mapper: object

serializedName

serializedName: string = "createTimeMin"

type

type: object

name

name: "DateTime" = "DateTime"

Const credentialName

credentialName: object

parameterPath

parameterPath: string = "credentialName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "credentialName"

type

type: object

name

name: "String" = "String"

Const dataMaskingPolicyName

dataMaskingPolicyName: object

parameterPath

parameterPath: string = "dataMaskingPolicyName"

mapper

mapper: object

defaultValue

defaultValue: string = "Default"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "dataMaskingPolicyName"

type

type: object

name

name: "String" = "String"

Const dataMaskingRuleName

dataMaskingRuleName: object

parameterPath

parameterPath: string = "dataMaskingRuleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "dataMaskingRuleName"

type

type: object

name

name: "String" = "String"

Const databaseName

databaseName: object

parameterPath

parameterPath: string = "databaseName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "databaseName"

type

type: object

name

name: "String" = "String"

Const databaseState

databaseState: object

parameterPath

parameterPath: string[] = ["options","databaseState"]

mapper

mapper: object

serializedName

serializedName: string = "databaseState"

type

type: object

name

name: "String" = "String"

Const dnsAliasName

dnsAliasName: object

parameterPath

parameterPath: string = "dnsAliasName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "dnsAliasName"

type

type: object

name

name: "String" = "String"

Const elasticPoolName

elasticPoolName: object

parameterPath

parameterPath: string = "elasticPoolName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "elasticPoolName"

type

type: object

name

name: "String" = "String"

Const encryptionProtectorName

encryptionProtectorName: object

parameterPath

parameterPath: string = "encryptionProtectorName"

mapper

mapper: object

defaultValue

defaultValue: string = "current"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "encryptionProtectorName"

type

type: object

name

name: "String" = "String"

Const endTime

endTime: object

parameterPath

parameterPath: string = "endTime"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "String" = "String"

Const endTimeMax

endTimeMax: object

parameterPath

parameterPath: string[] = ["options","endTimeMax"]

mapper

mapper: object

serializedName

serializedName: string = "endTimeMax"

type

type: object

name

name: "DateTime" = "DateTime"

Const endTimeMin

endTimeMin: object

parameterPath

parameterPath: string[] = ["options","endTimeMin"]

mapper

mapper: object

serializedName

serializedName: string = "endTimeMin"

type

type: object

name

name: "DateTime" = "DateTime"

Const extensionName

extensionName: object

parameterPath

parameterPath: string = "extensionName"

mapper

mapper: object

defaultValue

defaultValue: string = "import"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "extensionName"

type

type: object

name

name: "String" = "String"

Const failoverGroupName

failoverGroupName: object

parameterPath

parameterPath: string = "failoverGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "failoverGroupName"

type

type: object

name

name: "String" = "String"

Const filter0

filter0: object

parameterPath

parameterPath: string = "filter"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter1

filter1: object

parameterPath

parameterPath: string[] = ["options","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const firewallRuleName

firewallRuleName: object

parameterPath

parameterPath: string = "firewallRuleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "firewallRuleName"

type

type: object

name

name: "String" = "String"

Const geoBackupPolicyName

geoBackupPolicyName: object

parameterPath

parameterPath: string = "geoBackupPolicyName"

mapper

mapper: object

defaultValue

defaultValue: string = "Default"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "geoBackupPolicyName"

type

type: object

name

name: "String" = "String"

Const include

include: object

parameterPath

parameterPath: string[] = ["options","include"]

mapper

mapper: object

serializedName

serializedName: string = "include"

type

type: object

name

name: "String" = "String"

Const isActive

isActive: object

parameterPath

parameterPath: string[] = ["options","isActive"]

mapper

mapper: object

serializedName

serializedName: string = "isActive"

type

type: object

name

name: "Boolean" = "Boolean"

Const jobAgentName

jobAgentName: object

parameterPath

parameterPath: string = "jobAgentName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobAgentName"

type

type: object

name

name: "String" = "String"

Const jobExecutionId

jobExecutionId: object

parameterPath

parameterPath: string = "jobExecutionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobExecutionId"

type

type: object

name

name: "Uuid" = "Uuid"

Const jobName

jobName: object

parameterPath

parameterPath: string = "jobName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobName"

type

type: object

name

name: "String" = "String"

Const jobVersion

jobVersion: object

parameterPath

parameterPath: string = "jobVersion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobVersion"

type

type: object

name

name: "Number" = "Number"

Const keyName

keyName: object

parameterPath

parameterPath: string = "keyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "keyName"

type

type: object

name

name: "String" = "String"

Const linkId

linkId: object

parameterPath

parameterPath: string = "linkId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "linkId"

type

type: object

name

name: "String" = "String"

Const locationName

locationName: object

parameterPath

parameterPath: string = "locationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "locationName"

type

type: object

name

name: "String" = "String"

Const longTermRetentionDatabaseName

longTermRetentionDatabaseName: object

parameterPath

parameterPath: string = "longTermRetentionDatabaseName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "longTermRetentionDatabaseName"

type

type: object

name

name: "String" = "String"

Const longTermRetentionServerName

longTermRetentionServerName: object

parameterPath

parameterPath: string = "longTermRetentionServerName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "longTermRetentionServerName"

type

type: object

name

name: "String" = "String"

Const managedInstanceName

managedInstanceName: object

parameterPath

parameterPath: string = "managedInstanceName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "managedInstanceName"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const onlyLatestPerDatabase

onlyLatestPerDatabase: object

parameterPath

parameterPath: string[] = ["options","onlyLatestPerDatabase"]

mapper

mapper: object

serializedName

serializedName: string = "onlyLatestPerDatabase"

type

type: object

name

name: "Boolean" = "Boolean"

Const operationId

operationId: object

parameterPath

parameterPath: string = "operationId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "operationId"

type

type: object

name

name: "Uuid" = "Uuid"

Const policyName

policyName: object

parameterPath

parameterPath: string = "policyName"

mapper

mapper: object

defaultValue

defaultValue: string = "default"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "policyName"

type

type: object

name

name: "String" = "String"

Const recommendedElasticPoolName

recommendedElasticPoolName: object

parameterPath

parameterPath: string = "recommendedElasticPoolName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "recommendedElasticPoolName"

type

type: object

name

name: "String" = "String"

Const recoverableDatabaseName

recoverableDatabaseName: object

parameterPath

parameterPath: string = "recoverableDatabaseName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "recoverableDatabaseName"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

Const restorableDroppedDatabaseId

restorableDroppedDatabaseId: object

parameterPath

parameterPath: string = "restorableDroppedDatabaseId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "restorableDroppedDatabaseId"

type

type: object

name

name: "String" = "String"

Const restorableDroppededDatabaseId

restorableDroppededDatabaseId: object

parameterPath

parameterPath: string = "restorableDroppededDatabaseId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "restorableDroppededDatabaseId"

type

type: object

name

name: "String" = "String"

Const restorePointName

restorePointName: object

parameterPath

parameterPath: string = "restorePointName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "restorePointName"

type

type: object

name

name: "String" = "String"

Const ruleId

ruleId: object

parameterPath

parameterPath: string = "ruleId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "ruleId"

type

type: object

name

name: "String" = "String"

Const scanId

scanId: object

parameterPath

parameterPath: string = "scanId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "scanId"

type

type: object

name

name: "String" = "String"

Const schemaName

schemaName: object

parameterPath

parameterPath: string = "schemaName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "schemaName"

type

type: object

name

name: "String" = "String"

Const securityAlertPolicyName0

securityAlertPolicyName0: object

parameterPath

parameterPath: string = "securityAlertPolicyName"

mapper

mapper: object

defaultValue

defaultValue: string = "default"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "securityAlertPolicyName"

type

type: object

name

name: "String" = "String"

Const securityAlertPolicyName1

securityAlertPolicyName1: object

parameterPath

parameterPath: string = "securityAlertPolicyName"

mapper

mapper: object

defaultValue

defaultValue: string = "Default"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "securityAlertPolicyName"

type

type: object

name

name: "String" = "String"

Const sensitivityLabelSource0

sensitivityLabelSource0: object

parameterPath

parameterPath: string = "sensitivityLabelSource"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "sensitivityLabelSource"

type

type: object

allowedValues

allowedValues: string[] = ["current","recommended"]

name

name: "Enum" = "Enum"

Const sensitivityLabelSource1

sensitivityLabelSource1: object

parameterPath

parameterPath: string = "sensitivityLabelSource"

mapper

mapper: object

defaultValue

defaultValue: string = "current"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "sensitivityLabelSource"

type

type: object

name

name: "String" = "String"

Const serverName

serverName: object

parameterPath

parameterPath: string = "serverName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "serverName"

type

type: object

name

name: "String" = "String"

Const serviceObjectiveName

serviceObjectiveName: object

parameterPath

parameterPath: string = "serviceObjectiveName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "serviceObjectiveName"

type

type: object

name

name: "String" = "String"

Const serviceTierAdvisorName

serviceTierAdvisorName: object

parameterPath

parameterPath: string = "serviceTierAdvisorName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "serviceTierAdvisorName"

type

type: object

name

name: "String" = "String"

Const skip

skip: object

parameterPath

parameterPath: string[] = ["options","skip"]

mapper

mapper: object

serializedName

serializedName: string = "$skip"

type

type: object

name

name: "Number" = "Number"

Const skipToken

skipToken: object

parameterPath

parameterPath: string[] = ["options","skipToken"]

mapper

mapper: object

serializedName

serializedName: string = "$skipToken"

type

type: object

name

name: "String" = "String"

Const startTime

startTime: object

parameterPath

parameterPath: string = "startTime"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "String" = "String"

Const stepName

stepName: object

parameterPath

parameterPath: string = "stepName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "stepName"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const syncAgentName

syncAgentName: object

parameterPath

parameterPath: string = "syncAgentName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "syncAgentName"

type

type: object

name

name: "String" = "String"

Const syncGroupName

syncGroupName: object

parameterPath

parameterPath: string = "syncGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "syncGroupName"

type

type: object

name

name: "String" = "String"

Const syncMemberName

syncMemberName: object

parameterPath

parameterPath: string = "syncMemberName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "syncMemberName"

type

type: object

name

name: "String" = "String"

Const tableName

tableName: object

parameterPath

parameterPath: string = "tableName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "tableName"

type

type: object

name

name: "String" = "String"

Const targetGroupName

targetGroupName: object

parameterPath

parameterPath: string = "targetGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "targetGroupName"

type

type: object

name

name: "String" = "String"

Const targetId

targetId: object

parameterPath

parameterPath: string = "targetId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "targetId"

type

type: object

name

name: "Uuid" = "Uuid"

Const top

top: object

parameterPath

parameterPath: string[] = ["options","top"]

mapper

mapper: object

serializedName

serializedName: string = "$top"

type

type: object

name

name: "Number" = "Number"

Const transparentDataEncryptionName

transparentDataEncryptionName: object

parameterPath

parameterPath: string = "transparentDataEncryptionName"

mapper

mapper: object

defaultValue

defaultValue: string = "current"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "transparentDataEncryptionName"

type

type: object

name

name: "String" = "String"

Const type

type: object

parameterPath

parameterPath: string = "type"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const usageName

usageName: object

parameterPath

parameterPath: string = "usageName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "usageName"

type

type: object

name

name: "String" = "String"

Const virtualClusterName

virtualClusterName: object

parameterPath

parameterPath: string = "virtualClusterName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualClusterName"

type

type: object

name

name: "String" = "String"

Const virtualNetworkRuleName

virtualNetworkRuleName: object

parameterPath

parameterPath: string = "virtualNetworkRuleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualNetworkRuleName"

type

type: object

name

name: "String" = "String"

Const vulnerabilityAssessmentName

vulnerabilityAssessmentName: object

parameterPath

parameterPath: string = "vulnerabilityAssessmentName"

mapper

mapper: object

defaultValue

defaultValue: string = "default"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "vulnerabilityAssessmentName"

type

type: object

name

name: "String" = "String"

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc